Class TargetPool (1.58.0)

public final class TargetPool extends GeneratedMessageV3 implements TargetPoolOrBuilder

Represents a Target Pool resource. Target pools are used with external passthrough Network Load Balancers. A target pool references member instances, an associated legacy HttpHealthCheck resource, and, optionally, a backup target pool. For more information, read Using target pools.

Protobuf type google.cloud.compute.v1.TargetPool

Implements

TargetPoolOrBuilder

Static Fields

BACKUP_POOL_FIELD_NUMBER

public static final int BACKUP_POOL_FIELD_NUMBER
Field Value
Type Description
int

CREATION_TIMESTAMP_FIELD_NUMBER

public static final int CREATION_TIMESTAMP_FIELD_NUMBER
Field Value
Type Description
int

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
Type Description
int

FAILOVER_RATIO_FIELD_NUMBER

public static final int FAILOVER_RATIO_FIELD_NUMBER
Field Value
Type Description
int

HEALTH_CHECKS_FIELD_NUMBER

public static final int HEALTH_CHECKS_FIELD_NUMBER
Field Value
Type Description
int

ID_FIELD_NUMBER

public static final int ID_FIELD_NUMBER
Field Value
Type Description
int

INSTANCES_FIELD_NUMBER

public static final int INSTANCES_FIELD_NUMBER
Field Value
Type Description
int

KIND_FIELD_NUMBER

public static final int KIND_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

REGION_FIELD_NUMBER

public static final int REGION_FIELD_NUMBER
Field Value
Type Description
int

SECURITY_POLICY_FIELD_NUMBER

public static final int SECURITY_POLICY_FIELD_NUMBER
Field Value
Type Description
int
public static final int SELF_LINK_FIELD_NUMBER
Field Value
Type Description
int

SESSION_AFFINITY_FIELD_NUMBER

public static final int SESSION_AFFINITY_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static TargetPool getDefaultInstance()
Returns
Type Description
TargetPool

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static TargetPool.Builder newBuilder()
Returns
Type Description
TargetPool.Builder

newBuilder(TargetPool prototype)

public static TargetPool.Builder newBuilder(TargetPool prototype)
Parameter
Name Description
prototype TargetPool
Returns
Type Description
TargetPool.Builder

parseDelimitedFrom(InputStream input)

public static TargetPool parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
TargetPool
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static TargetPool parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TargetPool
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static TargetPool parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
TargetPool
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static TargetPool parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TargetPool
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static TargetPool parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
TargetPool
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static TargetPool parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TargetPool
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static TargetPool parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
TargetPool
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static TargetPool parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TargetPool
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static TargetPool parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
TargetPool
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static TargetPool parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TargetPool
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static TargetPool parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
TargetPool
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static TargetPool parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TargetPool
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<TargetPool> parser()
Returns
Type Description
Parser<TargetPool>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

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.

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.

getParserForType()

public Parser<TargetPool> getParserForType()
Returns
Type Description
Parser<TargetPool>
Overrides

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.

getSecurityPolicy()

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

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.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

hasSecurityPolicy()

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

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public TargetPool.Builder newBuilderForType()
Returns
Type Description
TargetPool.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected TargetPool.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
TargetPool.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public TargetPool.Builder toBuilder()
Returns
Type Description
TargetPool.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException