Class TargetPool.Builder (1.19.0)

Version 1.19.0

• 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 TargetPoolOrBuilder

Represents 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.Builder

Implements

TargetPoolOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns

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;

Parameter

Name	Description
values	Iterable<String> The healthChecks to add.

Returns

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;

Parameter

Name	Description
values	Iterable<String> The instances to add.

Returns

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;

Parameter

Name	Description
value	String The healthChecks to add.

Returns

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;

Parameter

Name	Description
value	ByteString The bytes of the healthChecks to add.

Returns

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;

Parameter

Name	Description
value	String The instances to add.

Returns

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;

Parameter

Name	Description
value	ByteString The bytes of the instances to add.

Returns

Type	Description
TargetPool.Builder	This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public TargetPool.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters

Name	Description
field	FieldDescriptor
value	Object

Returns

Type	Description
TargetPool.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public TargetPool build()

Returns

Type	Description
TargetPool

buildPartial()

public TargetPool buildPartial()

Returns

Type	Description
TargetPool

clear()

public TargetPool.Builder clear()

Returns

Type	Description
TargetPool.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

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;

Returns

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;

Returns

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;

Returns

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;

Returns

Type	Description
TargetPool.Builder	This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public TargetPool.Builder clearField(Descriptors.FieldDescriptor field)

Parameter

Name	Description
field	FieldDescriptor

Returns

Type	Description
TargetPool.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

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;

Returns

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;

Returns

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;

Returns

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;

Returns

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;

Returns

Type	Description
TargetPool.Builder	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public TargetPool.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter

Name	Description
oneof	OneofDescriptor

Returns

Type	Description
TargetPool.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearRegion()

public TargetPool.Builder clearRegion()

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

optional string region = 138946292;

Returns

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;

Returns

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;

Returns

Type	Description
TargetPool.Builder	This builder for chaining.

clone()

public TargetPool.Builder clone()

Returns

Type	Description
TargetPool.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

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;

Returns

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;

Returns

Type	Description
ByteString	The bytes for backupPool.

getCreationTimestamp()

public String getCreationTimestamp()

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Returns

Type	Description
String	The creationTimestamp.

getCreationTimestampBytes()

public ByteString getCreationTimestampBytes()

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Returns

Type	Description
ByteString	The bytes for creationTimestamp.

getDefaultInstanceForType()

public TargetPool getDefaultInstanceForType()

Returns

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;

Returns

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;

Returns

Type	Description
ByteString	The bytes for description.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns

Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

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;

Returns

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;

Parameter

Name	Description
index	int The index of the element to return.

Returns

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;

Parameter

Name	Description
index	int The index of the value to return.

Returns

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;

Returns

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;

Returns

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;

Returns

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;

Parameter

Name	Description
index	int The index of the element to return.

Returns

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;

Parameter

Name	Description
index	int The index of the value to return.

Returns

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;

Returns

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;

Returns

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;

Returns

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;

Returns

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;

Returns

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;

Returns

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;

Returns

Type	Description
String	The region.

getRegionBytes()

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

getSelfLink()

public String getSelfLink()

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

optional string self_link = 456214797;

Returns

Type	Description
String	The selfLink.

getSelfLinkBytes()

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

hasSelfLink()

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

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns

Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns

Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeFrom(TargetPool other)

public TargetPool.Builder mergeFrom(TargetPool other)

Parameter

Name	Description
other	TargetPool

Returns

Type	Description
TargetPool.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public TargetPool.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
TargetPool.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions

Type	Description
IOException

mergeFrom(Message other)

public TargetPool.Builder mergeFrom(Message other)

Parameter

Name	Description
other	Message

Returns

Type	Description
TargetPool.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeUnknownFields(UnknownFieldSet unknownFields)

public final TargetPool.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
unknownFields	UnknownFieldSet

Returns

Type	Description
TargetPool.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

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;

Parameter

Name	Description
value	String The backupPool to set.

Returns

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;

Parameter

Name	Description
value	ByteString The bytes for backupPool to set.

Returns

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;

Parameter

Name	Description
value	String The creationTimestamp to set.

Returns

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;

Parameter

Name	Description
value	ByteString The bytes for creationTimestamp to set.

Returns

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;

Parameter

Name	Description
value	String The description to set.

Returns

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;

Parameter

Name	Description
value	ByteString The bytes for description to set.

Returns

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;

Parameter

Name	Description
value	float The failoverRatio to set.

Returns

Type	Description
TargetPool.Builder	This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public TargetPool.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters

Name	Description
field	FieldDescriptor
value	Object

Returns

Type	Description
TargetPool.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

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;

Parameters

Name	Description
index	int The index to set the value at.
value	String The healthChecks to set.

Returns

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;

Parameter

Name	Description
value	long The id to set.

Returns

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;

Parameters

Name	Description
index	int The index to set the value at.
value	String The instances to set.

Returns

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;

Parameter

Name	Description
value	String The kind to set.

Returns

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;

Parameter

Name	Description
value	ByteString The bytes for kind to set.

Returns

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;

Parameter

Name	Description
value	String The name to set.

Returns

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;

Parameter

Name	Description
value	ByteString The bytes for name to set.

Returns

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;

Parameter

Name	Description
value	String The region to set.

Returns

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;

Parameter

Name	Description
value	ByteString The bytes for region to set.

Returns

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)

Parameters

Name	Description
field	FieldDescriptor
index	int
value	Object

Returns

Type	Description
TargetPool.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setSelfLink(String value)

public TargetPool.Builder setSelfLink(String value)

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

optional string self_link = 456214797;

Parameter

Name	Description
value	String The selfLink to set.

Returns

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;

Parameter

Name	Description
value	ByteString The bytes for selfLink to set.

Returns

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;

Parameter

Name	Description
value	String The sessionAffinity to set.

Returns

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;

Parameter

Name	Description
value	ByteString The bytes for sessionAffinity to set.

Returns

Type	Description
TargetPool.Builder	This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final TargetPool.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
unknownFields	UnknownFieldSet

Returns

Type	Description
TargetPool.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)