Class TargetPool (1.59.0)

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.

Protobuf type google.cloud.compute.v1.TargetPool

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.

optional string backup_pool = 45884537;

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.

optional string backup_pool = 45884537;

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

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

optional string description = 422937596;

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

optional string description = 422937596;

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.

optional float failover_ratio = 212667006;

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.

repeated string health_checks = 448370606;

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.

repeated string health_checks = 448370606;

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.

repeated string health_checks = 448370606;

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.

repeated string health_checks = 448370606;

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

optional uint64 id = 3355;

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.

repeated string instances = 29097598;

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.

repeated string instances = 29097598;

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.

repeated string instances = 29097598;

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.

repeated string instances = 29097598;

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

optional string kind = 3292052;

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

optional string kind = 3292052;

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? 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.

optional string name = 3373707;

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? 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.

optional string name = 3373707;

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

optional string region = 138946292;

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

optional string region = 138946292;

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

optional string security_policy = 171082513;

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

optional string security_policy = 171082513;

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

optional string self_link = 456214797;

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

optional string self_link = 456214797;

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.

optional string session_affinity = 463888561;

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.

optional string session_affinity = 463888561;

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.

optional string backup_pool = 45884537;

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

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

optional string description = 422937596;

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.

optional float failover_ratio = 212667006;

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

optional uint64 id = 3355;

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

optional string kind = 3292052;

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? 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.

optional string name = 3373707;

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

optional string region = 138946292;

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

optional string security_policy = 171082513;

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

optional string self_link = 456214797;

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.

optional string session_affinity = 463888561;