- 1.63.0 (latest)
- 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 static final class TargetPool.Builder extends GeneratedMessageV3.Builder<TargetPool.Builder> implements TargetPoolOrBuilderRepresents a Target Pool resource. Target pools are used for network TCP/UDP load balancing. 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
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > TargetPool.BuilderImplements
TargetPoolOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Type | Description |
| Descriptor |
Methods
addAllHealthChecks(Iterable<String> values)
public TargetPool.Builder addAllHealthChecks(Iterable<String> values)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;
| Name | Description |
| values | Iterable<String>The healthChecks to add. |
| Type | Description |
| TargetPool.Builder | This builder for chaining. |
addAllInstances(Iterable<String> values)
public TargetPool.Builder addAllInstances(Iterable<String> values)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;
| Name | Description |
| values | Iterable<String>The instances to add. |
| Type | Description |
| TargetPool.Builder | This builder for chaining. |
addHealthChecks(String value)
public TargetPool.Builder addHealthChecks(String value)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;
| Name | Description |
| value | StringThe healthChecks to add. |
| Type | Description |
| TargetPool.Builder | This builder for chaining. |
addHealthChecksBytes(ByteString value)
public TargetPool.Builder addHealthChecksBytes(ByteString value)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;
| Name | Description |
| value | ByteStringThe bytes of the healthChecks to add. |
| Type | Description |
| TargetPool.Builder | This builder for chaining. |
addInstances(String value)
public TargetPool.Builder addInstances(String value)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;
| Name | Description |
| value | StringThe instances to add. |
| Type | Description |
| TargetPool.Builder | This builder for chaining. |
addInstancesBytes(ByteString value)
public TargetPool.Builder addInstancesBytes(ByteString value)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;
| Name | Description |
| value | ByteStringThe bytes of the instances to add. |
| Type | Description |
| TargetPool.Builder | This builder for chaining. |
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public TargetPool.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Name | Description |
| field | FieldDescriptor |
| value | Object |
| Type | Description |
| TargetPool.Builder |
build()
public TargetPool build()| Type | Description |
| TargetPool |
buildPartial()
public TargetPool buildPartial()| Type | Description |
| TargetPool |
clear()
public TargetPool.Builder clear()| Type | Description |
| TargetPool.Builder |
clearBackupPool()
public TargetPool.Builder clearBackupPool()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;
| Type | Description |
| TargetPool.Builder | This builder for chaining. |
clearCreationTimestamp()
public TargetPool.Builder clearCreationTimestamp()[Output Only] Creation timestamp in RFC3339 text format.
optional string creation_timestamp = 30525366;
| Type | Description |
| TargetPool.Builder | This builder for chaining. |
clearDescription()
public TargetPool.Builder clearDescription()An optional description of this resource. Provide this property when you create the resource.
optional string description = 422937596;
| Type | Description |
| TargetPool.Builder | This builder for chaining. |
clearFailoverRatio()
public TargetPool.Builder clearFailoverRatio()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;
| Type | Description |
| TargetPool.Builder | This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public TargetPool.Builder clearField(Descriptors.FieldDescriptor field)| Name | Description |
| field | FieldDescriptor |
| Type | Description |
| TargetPool.Builder |
clearHealthChecks()
public TargetPool.Builder clearHealthChecks()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;
| Type | Description |
| TargetPool.Builder | This builder for chaining. |
clearId()
public TargetPool.Builder clearId()[Output Only] The unique identifier for the resource. This identifier is defined by the server.
optional uint64 id = 3355;
| Type | Description |
| TargetPool.Builder | This builder for chaining. |
clearInstances()
public TargetPool.Builder clearInstances()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;
| Type | Description |
| TargetPool.Builder | This builder for chaining. |
clearKind()
public TargetPool.Builder clearKind()[Output Only] Type of the resource. Always compute#targetPool for target pools.
optional string kind = 3292052;
| Type | Description |
| TargetPool.Builder | This builder for chaining. |
clearName()
public TargetPool.Builder clearName() 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;
| Type | Description |
| TargetPool.Builder | This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public TargetPool.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Name | Description |
| oneof | OneofDescriptor |
| Type | Description |
| TargetPool.Builder |
clearRegion()
public TargetPool.Builder clearRegion()[Output Only] URL of the region where the target pool resides.
optional string region = 138946292;
| Type | Description |
| TargetPool.Builder | This builder for chaining. |
clearSelfLink()
public TargetPool.Builder clearSelfLink()[Output Only] Server-defined URL for the resource.
optional string self_link = 456214797;
| Type | Description |
| TargetPool.Builder | This builder for chaining. |
clearSessionAffinity()
public TargetPool.Builder clearSessionAffinity()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;
| Type | Description |
| TargetPool.Builder | This builder for chaining. |
clone()
public TargetPool.Builder clone()| Type | Description |
| TargetPool.Builder |
getBackupPool()
public 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;
| Type | Description |
| String | The backupPool. |
getBackupPoolBytes()
public 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;
| Type | Description |
| ByteString | The bytes for backupPool. |
getCreationTimestamp()
public String getCreationTimestamp()[Output Only] Creation timestamp in RFC3339 text format.
optional string creation_timestamp = 30525366;
| Type | Description |
| String | The creationTimestamp. |
getCreationTimestampBytes()
public ByteString getCreationTimestampBytes()[Output Only] Creation timestamp in RFC3339 text format.
optional string creation_timestamp = 30525366;
| Type | Description |
| ByteString | The bytes for creationTimestamp. |
getDefaultInstanceForType()
public TargetPool getDefaultInstanceForType()| Type | Description |
| TargetPool |
getDescription()
public String getDescription()An optional description of this resource. Provide this property when you create the resource.
optional string description = 422937596;
| Type | Description |
| String | The description. |
getDescriptionBytes()
public ByteString getDescriptionBytes()An optional description of this resource. Provide this property when you create the resource.
optional string description = 422937596;
| Type | Description |
| ByteString | The bytes for description. |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Type | Description |
| Descriptor |
getFailoverRatio()
public 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;
| Type | Description |
| float | The failoverRatio. |
getHealthChecks(int index)
public 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;
| Name | Description |
| index | intThe index of the element to return. |
| Type | Description |
| String | The healthChecks at the given index. |
getHealthChecksBytes(int index)
public 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;
| Name | Description |
| index | intThe index of the value to return. |
| Type | Description |
| ByteString | The bytes of the healthChecks at the given index. |
getHealthChecksCount()
public 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;
| Type | Description |
| int | The count of healthChecks. |
getHealthChecksList()
public ProtocolStringList 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;
| Type | Description |
| ProtocolStringList | A list containing the healthChecks. |
getId()
public long getId()[Output Only] The unique identifier for the resource. This identifier is defined by the server.
optional uint64 id = 3355;
| Type | Description |
| long | The id. |
getInstances(int index)
public 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;
| Name | Description |
| index | intThe index of the element to return. |
| Type | Description |
| String | The instances at the given index. |
getInstancesBytes(int index)
public 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;
| Name | Description |
| index | intThe index of the value to return. |
| Type | Description |
| ByteString | The bytes of the instances at the given index. |
getInstancesCount()
public 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;
| Type | Description |
| int | The count of instances. |
getInstancesList()
public ProtocolStringList 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;
| Type | Description |
| ProtocolStringList | A list containing the instances. |
getKind()
public String getKind()[Output Only] Type of the resource. Always compute#targetPool for target pools.
optional string kind = 3292052;
| Type | Description |
| String | The kind. |
getKindBytes()
public ByteString getKindBytes()[Output Only] Type of the resource. Always compute#targetPool for target pools.
optional string kind = 3292052;
| Type | Description |
| ByteString | The bytes for kind. |
getName()
public 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;
| Type | Description |
| String | The name. |
getNameBytes()
public 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;
| Type | Description |
| ByteString | The bytes for name. |
getRegion()
public String getRegion()[Output Only] URL of the region where the target pool resides.
optional string region = 138946292;
| Type | Description |
| String | The region. |
getRegionBytes()
public ByteString getRegionBytes()[Output Only] URL of the region where the target pool resides.
optional string region = 138946292;
| Type | Description |
| ByteString | The bytes for region. |
getSelfLink()
public String getSelfLink()[Output Only] Server-defined URL for the resource.
optional string self_link = 456214797;
| Type | Description |
| String | The selfLink. |
getSelfLinkBytes()
public ByteString getSelfLinkBytes()[Output Only] Server-defined URL for the resource.
optional string self_link = 456214797;
| Type | Description |
| ByteString | The bytes for selfLink. |
getSessionAffinity()
public 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;
| Type | Description |
| String | The sessionAffinity. |
getSessionAffinityBytes()
public 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;
| Type | Description |
| ByteString | The bytes for sessionAffinity. |
hasBackupPool()
public 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;
| Type | Description |
| boolean | Whether the backupPool field is set. |
hasCreationTimestamp()
public boolean hasCreationTimestamp()[Output Only] Creation timestamp in RFC3339 text format.
optional string creation_timestamp = 30525366;
| Type | Description |
| boolean | Whether the creationTimestamp field is set. |
hasDescription()
public boolean hasDescription()An optional description of this resource. Provide this property when you create the resource.
optional string description = 422937596;
| Type | Description |
| boolean | Whether the description field is set. |
hasFailoverRatio()
public 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;
| Type | Description |
| boolean | Whether the failoverRatio field is set. |
hasId()
public boolean hasId()[Output Only] The unique identifier for the resource. This identifier is defined by the server.
optional uint64 id = 3355;
| Type | Description |
| boolean | Whether the id field is set. |
hasKind()
public boolean hasKind()[Output Only] Type of the resource. Always compute#targetPool for target pools.
optional string kind = 3292052;
| Type | Description |
| boolean | Whether the kind field is set. |
hasName()
public 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;
| Type | Description |
| boolean | Whether the name field is set. |
hasRegion()
public boolean hasRegion()[Output Only] URL of the region where the target pool resides.
optional string region = 138946292;
| Type | Description |
| boolean | Whether the region field is set. |
hasSelfLink()
public boolean hasSelfLink()[Output Only] Server-defined URL for the resource.
optional string self_link = 456214797;
| Type | Description |
| boolean | Whether the selfLink field is set. |
hasSessionAffinity()
public 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;
| Type | Description |
| boolean | Whether the sessionAffinity field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Type | Description |
| FieldAccessorTable |
isInitialized()
public final boolean isInitialized()| Type | Description |
| boolean |
mergeFrom(TargetPool other)
public TargetPool.Builder mergeFrom(TargetPool other)| Name | Description |
| other | TargetPool |
| Type | Description |
| TargetPool.Builder |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public TargetPool.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Name | Description |
| input | CodedInputStream |
| extensionRegistry | ExtensionRegistryLite |
| Type | Description |
| TargetPool.Builder |
| Type | Description |
| IOException |
mergeFrom(Message other)
public TargetPool.Builder mergeFrom(Message other)| Name | Description |
| other | Message |
| Type | Description |
| TargetPool.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final TargetPool.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Name | Description |
| unknownFields | UnknownFieldSet |
| Type | Description |
| TargetPool.Builder |
setBackupPool(String value)
public TargetPool.Builder setBackupPool(String value)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;
| Name | Description |
| value | StringThe backupPool to set. |
| Type | Description |
| TargetPool.Builder | This builder for chaining. |
setBackupPoolBytes(ByteString value)
public TargetPool.Builder setBackupPoolBytes(ByteString value)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;
| Name | Description |
| value | ByteStringThe bytes for backupPool to set. |
| Type | Description |
| TargetPool.Builder | This builder for chaining. |
setCreationTimestamp(String value)
public TargetPool.Builder setCreationTimestamp(String value)[Output Only] Creation timestamp in RFC3339 text format.
optional string creation_timestamp = 30525366;
| Name | Description |
| value | StringThe creationTimestamp to set. |
| Type | Description |
| TargetPool.Builder | This builder for chaining. |
setCreationTimestampBytes(ByteString value)
public TargetPool.Builder setCreationTimestampBytes(ByteString value)[Output Only] Creation timestamp in RFC3339 text format.
optional string creation_timestamp = 30525366;
| Name | Description |
| value | ByteStringThe bytes for creationTimestamp to set. |
| Type | Description |
| TargetPool.Builder | This builder for chaining. |
setDescription(String value)
public TargetPool.Builder setDescription(String value)An optional description of this resource. Provide this property when you create the resource.
optional string description = 422937596;
| Name | Description |
| value | StringThe description to set. |
| Type | Description |
| TargetPool.Builder | This builder for chaining. |
setDescriptionBytes(ByteString value)
public TargetPool.Builder setDescriptionBytes(ByteString value)An optional description of this resource. Provide this property when you create the resource.
optional string description = 422937596;
| Name | Description |
| value | ByteStringThe bytes for description to set. |
| Type | Description |
| TargetPool.Builder | This builder for chaining. |
setFailoverRatio(float value)
public TargetPool.Builder setFailoverRatio(float value)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;
| Name | Description |
| value | floatThe failoverRatio to set. |
| Type | Description |
| TargetPool.Builder | This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public TargetPool.Builder setField(Descriptors.FieldDescriptor field, Object value)| Name | Description |
| field | FieldDescriptor |
| value | Object |
| Type | Description |
| TargetPool.Builder |
setHealthChecks(int index, String value)
public TargetPool.Builder setHealthChecks(int index, String value)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;
| Name | Description |
| index | intThe index to set the value at. |
| value | StringThe healthChecks to set. |
| Type | Description |
| TargetPool.Builder | This builder for chaining. |
setId(long value)
public TargetPool.Builder setId(long value)[Output Only] The unique identifier for the resource. This identifier is defined by the server.
optional uint64 id = 3355;
| Name | Description |
| value | longThe id to set. |
| Type | Description |
| TargetPool.Builder | This builder for chaining. |
setInstances(int index, String value)
public TargetPool.Builder setInstances(int index, String value)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;
| Name | Description |
| index | intThe index to set the value at. |
| value | StringThe instances to set. |
| Type | Description |
| TargetPool.Builder | This builder for chaining. |
setKind(String value)
public TargetPool.Builder setKind(String value)[Output Only] Type of the resource. Always compute#targetPool for target pools.
optional string kind = 3292052;
| Name | Description |
| value | StringThe kind to set. |
| Type | Description |
| TargetPool.Builder | This builder for chaining. |
setKindBytes(ByteString value)
public TargetPool.Builder setKindBytes(ByteString value)[Output Only] Type of the resource. Always compute#targetPool for target pools.
optional string kind = 3292052;
| Name | Description |
| value | ByteStringThe bytes for kind to set. |
| Type | Description |
| TargetPool.Builder | This builder for chaining. |
setName(String value)
public TargetPool.Builder setName(String value) 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 | Description |
| value | StringThe name to set. |
| Type | Description |
| TargetPool.Builder | This builder for chaining. |
setNameBytes(ByteString value)
public TargetPool.Builder setNameBytes(ByteString value) 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 | Description |
| value | ByteStringThe bytes for name to set. |
| Type | Description |
| TargetPool.Builder | This builder for chaining. |
setRegion(String value)
public TargetPool.Builder setRegion(String value)[Output Only] URL of the region where the target pool resides.
optional string region = 138946292;
| Name | Description |
| value | StringThe region to set. |
| Type | Description |
| TargetPool.Builder | This builder for chaining. |
setRegionBytes(ByteString value)
public TargetPool.Builder setRegionBytes(ByteString value)[Output Only] URL of the region where the target pool resides.
optional string region = 138946292;
| Name | Description |
| value | ByteStringThe bytes for region to set. |
| Type | Description |
| TargetPool.Builder | This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public TargetPool.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Name | Description |
| field | FieldDescriptor |
| index | int |
| value | Object |
| Type | Description |
| TargetPool.Builder |
setSelfLink(String value)
public TargetPool.Builder setSelfLink(String value)[Output Only] Server-defined URL for the resource.
optional string self_link = 456214797;
| Name | Description |
| value | StringThe selfLink to set. |
| Type | Description |
| TargetPool.Builder | This builder for chaining. |
setSelfLinkBytes(ByteString value)
public TargetPool.Builder setSelfLinkBytes(ByteString value)[Output Only] Server-defined URL for the resource.
optional string self_link = 456214797;
| Name | Description |
| value | ByteStringThe bytes for selfLink to set. |
| Type | Description |
| TargetPool.Builder | This builder for chaining. |
setSessionAffinity(String value)
public TargetPool.Builder setSessionAffinity(String value)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;
| Name | Description |
| value | StringThe sessionAffinity to set. |
| Type | Description |
| TargetPool.Builder | This builder for chaining. |
setSessionAffinityBytes(ByteString value)
public TargetPool.Builder setSessionAffinityBytes(ByteString value)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;
| Name | Description |
| value | ByteStringThe bytes for sessionAffinity to set. |
| Type | Description |
| TargetPool.Builder | This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final TargetPool.Builder setUnknownFields(UnknownFieldSet unknownFields)| Name | Description |
| unknownFields | UnknownFieldSet |
| Type | Description |
| TargetPool.Builder |