Package com.google.cloud.compute.v1

Interface TargetPoolOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
TargetPool, TargetPool.Builder
@Generated public interface TargetPoolOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getBackupPool()
    The server-defined URL for the resource.
    com.google.protobuf.ByteString
    getBackupPoolBytes()
    The server-defined URL for the resource.
    String
    getCreationTimestamp()
    Output only.
    com.google.protobuf.ByteString
    getCreationTimestampBytes()
    Output only.
    String
    getDescription()
    An optional description of this resource.
    com.google.protobuf.ByteString
    getDescriptionBytes()
    An optional description of this resource.
    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).
    String
    getHealthChecks(int index)
    The URL of the HttpHealthCheck resource.
    com.google.protobuf.ByteString
    getHealthChecksBytes(int index)
    The URL of the HttpHealthCheck resource.
    int
    getHealthChecksCount()
    The URL of the HttpHealthCheck resource.
    List<String>
    getHealthChecksList()
    The URL of the HttpHealthCheck resource.
    long
    getId()
    [Output Only] The unique identifier for the resource.
    String
    getInstances(int index)
    A list of resource URLs to the virtual machine instances serving this pool.
    com.google.protobuf.ByteString
    getInstancesBytes(int index)
    A list of resource URLs to the virtual machine instances serving this pool.
    int
    getInstancesCount()
    A list of resource URLs to the virtual machine instances serving this pool.
    List<String>
    getInstancesList()
    A list of resource URLs to the virtual machine instances serving this pool.
    String
    getKind()
    Output only.
    com.google.protobuf.ByteString
    getKindBytes()
    Output only.
    String
    getName()
    Name of the resource.
    com.google.protobuf.ByteString
    getNameBytes()
    Name of the resource.
    String
    getRegion()
    Output only.
    com.google.protobuf.ByteString
    getRegionBytes()
    Output only.
    String
    getSecurityPolicy()
    [Output Only] The resource URL for the security policy associated with this target pool.
    com.google.protobuf.ByteString
    getSecurityPolicyBytes()
    [Output Only] The resource URL for the security policy associated with this target pool.
    String
    getSelfLink()
    [Output Only] Server-defined URL for the resource.
    com.google.protobuf.ByteString
    getSelfLinkBytes()
    [Output Only] Server-defined URL for the resource.
    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.
    com.google.protobuf.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.
    boolean
    hasBackupPool()
    The server-defined URL for the resource.
    boolean
    hasCreationTimestamp()
    Output only.
    boolean
    hasDescription()
    An optional description of this resource.
    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).
    boolean
    hasId()
    [Output Only] The unique identifier for the resource.
    boolean
    hasKind()
    Output only.
    boolean
    hasName()
    Name of the resource.
    boolean
    hasRegion()
    Output only.
    boolean
    hasSecurityPolicy()
    [Output Only] The resource URL for the security policy associated with this target pool.
    boolean
    hasSelfLink()
    [Output Only] Server-defined URL for the resource.
    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.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • hasBackupPool

      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 belowfailoverRatio, 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:
      Whether the backupPool field is set.

    • getBackupPool

      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 belowfailoverRatio, 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:
      The backupPool.

    • getBackupPoolBytes

      com.google.protobuf.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 belowfailoverRatio, 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:
      The bytes for backupPool.

    • hasCreationTimestamp

      boolean hasCreationTimestamp()
       Output only. [Output Only] Creation timestamp inRFC3339
 text format.
      optional string creation_timestamp = 30525366;
      Returns:
      Whether the creationTimestamp field is set.

    • getCreationTimestamp

      String getCreationTimestamp()
       Output only. [Output Only] Creation timestamp inRFC3339
 text format.
      optional string creation_timestamp = 30525366;
      Returns:
      The creationTimestamp.

    • getCreationTimestampBytes

      com.google.protobuf.ByteString getCreationTimestampBytes()
       Output only. [Output Only] Creation timestamp inRFC3339
 text format.
      optional string creation_timestamp = 30525366;
      Returns:
      The bytes for creationTimestamp.

    • hasDescription

      boolean hasDescription()
       An optional description of this resource. Provide this property when you
 create the resource.
      optional string description = 422937596;
      Returns:
      Whether the description field is set.

    • getDescription

      String getDescription()
       An optional description of this resource. Provide this property when you
 create the resource.
      optional string description = 422937596;
      Returns:
      The description.

    • getDescriptionBytes

      com.google.protobuf.ByteString getDescriptionBytes()
       An optional description of this resource. Provide this property when you
 create the resource.
      optional string description = 422937596;
      Returns:
      The bytes for description.

    • hasFailoverRatio

      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:
      Whether the failoverRatio field is set.

    • getFailoverRatio

      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:
      The failoverRatio.

    • getHealthChecksList

      List<String> getHealthChecksList()
       The URL of the HttpHealthCheck resource. A member instance in this
 pool is considered healthy if and only if the health checks pass.
 Only legacy HttpHealthChecks are supported. Only one health check may be
 specified.
      repeated string health_checks = 448370606;
      Returns:
      A list containing the healthChecks.

    • getHealthChecksCount

      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:
      The count of healthChecks.

    • getHealthChecks

      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;
      Parameters:
      index - The index of the element to return.
      Returns:
      The healthChecks at the given index.

    • getHealthChecksBytes

      com.google.protobuf.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;
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the healthChecks at the given index.

    • hasId

      boolean hasId()
       [Output Only] The unique identifier for the resource. This identifier is
 defined by the server.
      optional uint64 id = 3355;
      Returns:
      Whether the id field is set.

    • getId

      long getId()
       [Output Only] The unique identifier for the resource. This identifier is
 defined by the server.
      optional uint64 id = 3355;
      Returns:
      The id.

    • getInstancesList

      List<String> getInstancesList()
       A list of resource URLs to the virtual machine instances serving this pool.
 They must live in zones contained in the same region as this pool.
      repeated string instances = 29097598;
      Returns:
      A list containing the instances.

    • getInstancesCount

      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:
      The count of instances.

    • getInstances

      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;
      Parameters:
      index - The index of the element to return.
      Returns:
      The instances at the given index.

    • getInstancesBytes

      com.google.protobuf.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;
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the instances at the given index.

    • hasKind

      boolean hasKind()
       Output only. [Output Only] Type of the resource. Always compute#targetPool
 for target pools.
      optional string kind = 3292052;
      Returns:
      Whether the kind field is set.

    • getKind

      String getKind()
       Output only. [Output Only] Type of the resource. Always compute#targetPool
 for target pools.
      optional string kind = 3292052;
      Returns:
      The kind.

    • getKindBytes

      com.google.protobuf.ByteString getKindBytes()
       Output only. [Output Only] Type of the resource. Always compute#targetPool
 for target pools.
      optional string kind = 3292052;
      Returns:
      The bytes for kind.

    • hasName

      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 withRFC1035.
 Specifically, the name must be 1-63 characters long and match the regular
 expression `[a-z]([-a-z0-9]*[a-z0-9])?` 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:
      Whether the name field is set.

    • getName

      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 withRFC1035.
 Specifically, the name must be 1-63 characters long and match the regular
 expression `[a-z]([-a-z0-9]*[a-z0-9])?` 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:
      The name.

    • getNameBytes

      com.google.protobuf.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 withRFC1035.
 Specifically, the name must be 1-63 characters long and match the regular
 expression `[a-z]([-a-z0-9]*[a-z0-9])?` 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:
      The bytes for name.

    • hasRegion

      boolean hasRegion()
       Output only. [Output Only] URL of the region where the target pool resides.
      optional string region = 138946292;
      Returns:
      Whether the region field is set.

    • getRegion

      String getRegion()
       Output only. [Output Only] URL of the region where the target pool resides.
      optional string region = 138946292;
      Returns:
      The region.

    • getRegionBytes

      com.google.protobuf.ByteString getRegionBytes()
       Output only. [Output Only] URL of the region where the target pool resides.
      optional string region = 138946292;
      Returns:
      The bytes for region.

    • hasSecurityPolicy

      boolean hasSecurityPolicy()
       [Output Only] The resource URL for the security policy associated with this
 target pool.
      optional string security_policy = 171082513;
      Returns:
      Whether the securityPolicy field is set.

    • getSecurityPolicy

      String getSecurityPolicy()
       [Output Only] The resource URL for the security policy associated with this
 target pool.
      optional string security_policy = 171082513;
      Returns:
      The securityPolicy.

    • getSecurityPolicyBytes

      com.google.protobuf.ByteString getSecurityPolicyBytes()
       [Output Only] The resource URL for the security policy associated with this
 target pool.
      optional string security_policy = 171082513;
      Returns:
      The bytes for securityPolicy.

    • hasSelfLink

      boolean hasSelfLink()
       [Output Only] Server-defined URL for the resource.
      optional string self_link = 456214797;
      Returns:
      Whether the selfLink field is set.

    • getSelfLink

      String getSelfLink()
       [Output Only] Server-defined URL for the resource.
      optional string self_link = 456214797;
      Returns:
      The selfLink.

    • getSelfLinkBytes

      com.google.protobuf.ByteString getSelfLinkBytes()
       [Output Only] Server-defined URL for the resource.
      optional string self_link = 456214797;
      Returns:
      The bytes for selfLink.

    • hasSessionAffinity

      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:
      Whether the sessionAffinity field is set.

    • getSessionAffinity

      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:
      The sessionAffinity.

    • getSessionAffinityBytes

      com.google.protobuf.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:
      The bytes for sessionAffinity.