Google Cloud Compute V1 API - Class Google::Cloud::Compute::V1::TargetPool (v2.11.0)

Version 2.11.0

• 2.12.0 (latest)
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.2
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.0
• 1.10.0
• 1.9.0
• 1.8.0
• 1.7.1
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0
• 0.5.0

Reference documentation and code samples for the Google Cloud Compute V1 API class Google::Cloud::Compute::V1::TargetPool.

Represents a Target Pool resource. Target pools are used with external passthrough Network Load Balancers. A target pool references member instances, an associated legacy HttpHealthCheck resource, and, optionally, a backup target pool. For more information, read Using target pools.

Inherits

• Object

Extended By

• Google::Protobuf::MessageExts::ClassMethods

Includes

• Google::Protobuf::MessageExts

Methods

#backup_pool

def backup_pool() -> ::String

Returns

• (::String) — The server-defined URL for the resource. This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool, and its failoverRatio field is properly set to a value between [0, 1]. backupPool and failoverRatio together define the fallback behavior of the primary target pool: if the ratio of the healthy instances in the primary pool is at or below failoverRatio, traffic arriving at the load-balanced IP will be directed to the backup pool. In case where failoverRatio and backupPool are not set, or all the instances in the backup pool are unhealthy, the traffic will be directed back to the primary pool in the "force" mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy.

#backup_pool=

def backup_pool=(value) -> ::String

Parameter

• value (::String) — The server-defined URL for the resource. This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool, and its failoverRatio field is properly set to a value between [0, 1]. backupPool and failoverRatio together define the fallback behavior of the primary target pool: if the ratio of the healthy instances in the primary pool is at or below failoverRatio, traffic arriving at the load-balanced IP will be directed to the backup pool. In case where failoverRatio and backupPool are not set, or all the instances in the backup pool are unhealthy, the traffic will be directed back to the primary pool in the "force" mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy.

Returns

• (::String) — The server-defined URL for the resource. This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool, and its failoverRatio field is properly set to a value between [0, 1]. backupPool and failoverRatio together define the fallback behavior of the primary target pool: if the ratio of the healthy instances in the primary pool is at or below failoverRatio, traffic arriving at the load-balanced IP will be directed to the backup pool. In case where failoverRatio and backupPool are not set, or all the instances in the backup pool are unhealthy, the traffic will be directed back to the primary pool in the "force" mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy.

#creation_timestamp

def creation_timestamp() -> ::String

Returns

• (::String) — [Output Only] Creation timestamp in RFC3339 text format.

#creation_timestamp=

def creation_timestamp=(value) -> ::String

Parameter

• value (::String) — [Output Only] Creation timestamp in RFC3339 text format.

Returns

• (::String) — [Output Only] Creation timestamp in RFC3339 text format.

#description

def description() -> ::String

Returns

• (::String) — An optional description of this resource. Provide this property when you create the resource.

#description=

def description=(value) -> ::String

Parameter

• value (::String) — An optional description of this resource. Provide this property when you create the resource.

Returns

• (::String) — An optional description of this resource. Provide this property when you create the resource.

#failover_ratio

def failover_ratio() -> ::Float

Returns

• (::Float) — This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool (i.e., not as a backup pool to some other target pool). The value of the field must be in [0, 1]. If set, backupPool must also be set. They together define the fallback behavior of the primary target pool: if the ratio of the healthy instances in the primary pool is at or below this number, traffic arriving at the load-balanced IP will be directed to the backup pool. In case where failoverRatio is not set or all the instances in the backup pool are unhealthy, the traffic will be directed back to the primary pool in the "force" mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy.

#failover_ratio=

def failover_ratio=(value) -> ::Float

Parameter

• value (::Float) — This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool (i.e., not as a backup pool to some other target pool). The value of the field must be in [0, 1]. If set, backupPool must also be set. They together define the fallback behavior of the primary target pool: if the ratio of the healthy instances in the primary pool is at or below this number, traffic arriving at the load-balanced IP will be directed to the backup pool. In case where failoverRatio is not set or all the instances in the backup pool are unhealthy, the traffic will be directed back to the primary pool in the "force" mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy.

Returns

• (::Float) — This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool (i.e., not as a backup pool to some other target pool). The value of the field must be in [0, 1]. If set, backupPool must also be set. They together define the fallback behavior of the primary target pool: if the ratio of the healthy instances in the primary pool is at or below this number, traffic arriving at the load-balanced IP will be directed to the backup pool. In case where failoverRatio is not set or all the instances in the backup pool are unhealthy, the traffic will be directed back to the primary pool in the "force" mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy.

#health_checks

def health_checks() -> ::Array<::String>

Returns

• (::Array<::String>) — The URL of the HttpHealthCheck resource. A member instance in this pool is considered healthy if and only if the health checks pass. Only legacy HttpHealthChecks are supported. Only one health check may be specified.

#health_checks=

def health_checks=(value) -> ::Array<::String>

Parameter

• value (::Array<::String>) — The URL of the HttpHealthCheck resource. A member instance in this pool is considered healthy if and only if the health checks pass. Only legacy HttpHealthChecks are supported. Only one health check may be specified.

Returns

• (::Array<::String>) — The URL of the HttpHealthCheck resource. A member instance in this pool is considered healthy if and only if the health checks pass. Only legacy HttpHealthChecks are supported. Only one health check may be specified.

#id

def id() -> ::Integer

Returns

• (::Integer) — [Output Only] The unique identifier for the resource. This identifier is defined by the server.

#id=

def id=(value) -> ::Integer

Parameter

• value (::Integer) — [Output Only] The unique identifier for the resource. This identifier is defined by the server.

Returns

• (::Integer) — [Output Only] The unique identifier for the resource. This identifier is defined by the server.

#instances

def instances() -> ::Array<::String>

Returns

• (::Array<::String>) — A list of resource URLs to the virtual machine instances serving this pool. They must live in zones contained in the same region as this pool.

#instances=

def instances=(value) -> ::Array<::String>

Parameter

• value (::Array<::String>) — A list of resource URLs to the virtual machine instances serving this pool. They must live in zones contained in the same region as this pool.

Returns

• (::Array<::String>) — A list of resource URLs to the virtual machine instances serving this pool. They must live in zones contained in the same region as this pool.

#kind

def kind() -> ::String

Returns

• (::String) — [Output Only] Type of the resource. Always compute#targetPool for target pools.

#kind=

def kind=(value) -> ::String

Parameter

• value (::String) — [Output Only] Type of the resource. Always compute#targetPool for target pools.

Returns

• (::String) — [Output Only] Type of the resource. Always compute#targetPool for target pools.

#name

def name() -> ::String

Returns

• (::String) — Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

#name=

def name=(value) -> ::String

Parameter

• value (::String) — Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

Returns

• (::String) — Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

#region

def region() -> ::String

Returns

• (::String) — [Output Only] URL of the region where the target pool resides.

#region=

def region=(value) -> ::String

Parameter

• value (::String) — [Output Only] URL of the region where the target pool resides.

Returns

• (::String) — [Output Only] URL of the region where the target pool resides.

#security_policy

def security_policy() -> ::String

Returns

• (::String) — [Output Only] The resource URL for the security policy associated with this target pool.

#security_policy=

def security_policy=(value) -> ::String

Parameter

• value (::String) — [Output Only] The resource URL for the security policy associated with this target pool.

Returns

• (::String) — [Output Only] The resource URL for the security policy associated with this target pool.

#self_link

def self_link() -> ::String

Returns

• (::String) — [Output Only] Server-defined URL for the resource.

#self_link=

def self_link=(value) -> ::String

Parameter

• value (::String) — [Output Only] Server-defined URL for the resource.

Returns

• (::String) — [Output Only] Server-defined URL for the resource.

#session_affinity

def session_affinity() -> ::String

Returns

• (::String) — Session affinity option, must be one of the following values: NONE: Connections from the same client IP may go to any instance in the pool. CLIENT_IP: Connections from the same client IP will go to the same instance in the pool while that instance remains healthy. CLIENT_IP_PROTO: Connections from the same client IP with the same IP protocol will go to the same instance in the pool while that instance remains healthy. Check the SessionAffinity enum for the list of possible values.

#session_affinity=

def session_affinity=(value) -> ::String

Parameter

• value (::String) — Session affinity option, must be one of the following values: NONE: Connections from the same client IP may go to any instance in the pool. CLIENT_IP: Connections from the same client IP will go to the same instance in the pool while that instance remains healthy. CLIENT_IP_PROTO: Connections from the same client IP with the same IP protocol will go to the same instance in the pool while that instance remains healthy. Check the SessionAffinity enum for the list of possible values.

Returns

• (::String) — Session affinity option, must be one of the following values: NONE: Connections from the same client IP may go to any instance in the pool. CLIENT_IP: Connections from the same client IP will go to the same instance in the pool while that instance remains healthy. CLIENT_IP_PROTO: Connections from the same client IP with the same IP protocol will go to the same instance in the pool while that instance remains healthy. Check the SessionAffinity enum for the list of possible values.