Compute Engine v1 API - Class TargetPool (3.2.0)

Reference documentation and code samples for the Compute Engine v1 API class 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.

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.

[Output Only] Creation timestamp in RFC3339 text format.

An optional description of this resource. Provide this property when you create the resource.

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.

Gets whether the "backup_pool" field is set

Gets whether the "creation_timestamp" field is set

Gets whether the "description" field is set

Gets whether the "failover_ratio" field is set

Gets whether the "id" field is set

Gets whether the "kind" field is set

Gets whether the "name" field is set

Gets whether the "region" field is set

Gets whether the "security_policy" field is set

Gets whether the "self_link" field is set

Gets whether the "session_affinity" field is set

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.

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

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.

[Output Only] Type of the resource. Always compute#targetPool for target pools.

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.

[Output Only] URL of the region where the target pool resides.

[Output Only] The resource URL for the security policy associated with this target pool.

[Output Only] Server-defined URL for the resource.

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.