- 1.64.0 (latest)
- 1.63.0
- 1.62.0
- 1.61.0
- 1.59.0
- 1.58.0
- 1.57.0
- 1.56.0
- 1.55.0
- 1.54.0
- 1.53.0
- 1.52.0
- 1.51.0
- 1.50.0
- 1.49.0
- 1.47.0
- 1.46.0
- 1.45.0
- 1.44.0
- 1.43.0
- 1.42.0
- 1.41.0
- 1.40.0
- 1.39.0
- 1.38.0
- 1.37.0
- 1.34.0
- 1.33.0
- 1.32.0
- 1.31.0
- 1.30.0
- 1.29.0
- 1.28.0
- 1.27.0
- 1.26.0
- 1.25.0
- 1.24.0
- 1.23.0
- 1.22.0
- 1.21.0
- 1.20.0
- 1.19.0
- 1.18.0
- 1.17.0
- 1.16.0
- 1.15.0
- 1.14.0
- 1.13.0
- 1.12.1
- 1.11.0
- 1.9.1
- 1.8.1
- 1.7.2
- 1.6.0-beta
public interface TargetPoolOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
getBackupPool()
public abstract String getBackupPool()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;
| Returns | |
|---|---|
| Type | Description |
String | The backupPool. |
getBackupPoolBytes()
public abstract ByteString getBackupPoolBytes()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;
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for backupPool. |
getCreationTimestamp()
public abstract String getCreationTimestamp()[Output Only] Creation timestamp in RFC3339 text format.
optional string creation_timestamp = 30525366;
| Returns | |
|---|---|
| Type | Description |
String | The creationTimestamp. |
getCreationTimestampBytes()
public abstract ByteString getCreationTimestampBytes()[Output Only] Creation timestamp in RFC3339 text format.
optional string creation_timestamp = 30525366;
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for creationTimestamp. |
getDescription()
public abstract String getDescription()An optional description of this resource. Provide this property when you create the resource.
optional string description = 422937596;
| Returns | |
|---|---|
| Type | Description |
String | The description. |
getDescriptionBytes()
public abstract ByteString getDescriptionBytes()An optional description of this resource. Provide this property when you create the resource.
optional string description = 422937596;
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for description. |
getFailoverRatio()
public abstract float getFailoverRatio()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;
| Returns | |
|---|---|
| Type | Description |
float | The failoverRatio. |
getHealthChecks(int index)
public abstract String getHealthChecks(int index)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;
| Parameter | |
|---|---|
| Name | Description |
index | intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
String | The healthChecks at the given index. |
getHealthChecksBytes(int index)
public abstract ByteString getHealthChecksBytes(int index)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;
| Parameter | |
|---|---|
| Name | Description |
index | intThe index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes of the healthChecks at the given index. |
getHealthChecksCount()
public abstract int getHealthChecksCount()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;
| Returns | |
|---|---|
| Type | Description |
int | The count of healthChecks. |
getHealthChecksList()
public abstract List<String> getHealthChecksList()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;
| Returns | |
|---|---|
| Type | Description |
List<String> | A list containing the healthChecks. |
getId()
public abstract long getId()[Output Only] The unique identifier for the resource. This identifier is defined by the server.
optional uint64 id = 3355;
| Returns | |
|---|---|
| Type | Description |
long | The id. |
getInstances(int index)
public abstract String getInstances(int index)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;
| Parameter | |
|---|---|
| Name | Description |
index | intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
String | The instances at the given index. |
getInstancesBytes(int index)
public abstract ByteString getInstancesBytes(int index)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;
| Parameter | |
|---|---|
| Name | Description |
index | intThe index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes of the instances at the given index. |
getInstancesCount()
public abstract int getInstancesCount()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;
| Returns | |
|---|---|
| Type | Description |
int | The count of instances. |
getInstancesList()
public abstract List<String> getInstancesList()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;
| Returns | |
|---|---|
| Type | Description |
List<String> | A list containing the instances. |
getKind()
public abstract String getKind()[Output Only] Type of the resource. Always compute#targetPool for target pools.
optional string kind = 3292052;
| Returns | |
|---|---|
| Type | Description |
String | The kind. |
getKindBytes()
public abstract ByteString getKindBytes()[Output Only] Type of the resource. Always compute#targetPool for target pools.
optional string kind = 3292052;
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for kind. |
getName()
public abstract String getName() 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;
| Returns | |
|---|---|
| Type | Description |
String | The name. |
getNameBytes()
public abstract ByteString getNameBytes() 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;
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for name. |
getRegion()
public abstract String getRegion()[Output Only] URL of the region where the target pool resides.
optional string region = 138946292;
| Returns | |
|---|---|
| Type | Description |
String | The region. |
getRegionBytes()
public abstract ByteString getRegionBytes()[Output Only] URL of the region where the target pool resides.
optional string region = 138946292;
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for region. |
getSecurityPolicy()
public abstract String getSecurityPolicy()[Output Only] The resource URL for the security policy associated with this target pool.
optional string security_policy = 171082513;
| Returns | |
|---|---|
| Type | Description |
String | The securityPolicy. |
getSecurityPolicyBytes()
public abstract ByteString getSecurityPolicyBytes()[Output Only] The resource URL for the security policy associated with this target pool.
optional string security_policy = 171082513;
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for securityPolicy. |
getSelfLink()
public abstract String getSelfLink()[Output Only] Server-defined URL for the resource.
optional string self_link = 456214797;
| Returns | |
|---|---|
| Type | Description |
String | The selfLink. |
getSelfLinkBytes()
public abstract ByteString getSelfLinkBytes()[Output Only] Server-defined URL for the resource.
optional string self_link = 456214797;
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for selfLink. |
getSessionAffinity()
public abstract String getSessionAffinity()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;
| Returns | |
|---|---|
| Type | Description |
String | The sessionAffinity. |
getSessionAffinityBytes()
public abstract ByteString getSessionAffinityBytes()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;
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for sessionAffinity. |
hasBackupPool()
public abstract boolean hasBackupPool()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;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the backupPool field is set. |
hasCreationTimestamp()
public abstract boolean hasCreationTimestamp()[Output Only] Creation timestamp in RFC3339 text format.
optional string creation_timestamp = 30525366;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the creationTimestamp field is set. |
hasDescription()
public abstract boolean hasDescription()An optional description of this resource. Provide this property when you create the resource.
optional string description = 422937596;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the description field is set. |
hasFailoverRatio()
public abstract boolean hasFailoverRatio()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;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the failoverRatio field is set. |
hasId()
public abstract boolean hasId()[Output Only] The unique identifier for the resource. This identifier is defined by the server.
optional uint64 id = 3355;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the id field is set. |
hasKind()
public abstract boolean hasKind()[Output Only] Type of the resource. Always compute#targetPool for target pools.
optional string kind = 3292052;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the kind field is set. |
hasName()
public abstract boolean hasName() 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;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the name field is set. |
hasRegion()
public abstract boolean hasRegion()[Output Only] URL of the region where the target pool resides.
optional string region = 138946292;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the region field is set. |
hasSecurityPolicy()
public abstract boolean hasSecurityPolicy()[Output Only] The resource URL for the security policy associated with this target pool.
optional string security_policy = 171082513;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the securityPolicy field is set. |
hasSelfLink()
public abstract boolean hasSelfLink()[Output Only] Server-defined URL for the resource.
optional string self_link = 456214797;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the selfLink field is set. |
hasSessionAffinity()
public abstract boolean hasSessionAffinity()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;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the sessionAffinity field is set. |