Class: Google::Cloud::Compute::V1::TargetPool

Inherits:

Object

Object
Google::Cloud::Compute::V1::TargetPool

show all

Extended by:: Protobuf::MessageExts::ClassMethods

Includes:: Protobuf::MessageExts

Defined in:: proto_docs/google/cloud/compute/v1/compute.rb

Overview

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. (== resource_for {$api_version}.targetPools ==)

Defined Under Namespace

Modules: SessionAffinity

Instance Attribute Summary collapse

#backup_pool ⇒ ::String
The server-defined URL for the resource.
#creation_timestamp ⇒ ::String
[Output Only] Creation timestamp in RFC3339 text format.
#description ⇒ ::String
An optional description of this resource.
#failover_ratio ⇒ ::Float
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).
#health_checks ⇒ ::Array<::String>
The URL of the HttpHealthCheck resource.
#id ⇒ ::String
[Output Only] The unique identifier for the resource.
#instances ⇒ ::Array<::String>
A list of resource URLs to the virtual machine instances serving this pool.
#kind ⇒ ::String
[Output Only] Type of the resource.
#name ⇒ ::String
Name of the resource.
#region ⇒ ::String
[Output Only] URL of the region where the target pool resides.
#self_link ⇒ ::String
[Output Only] Server-defined URL for the resource.
#session_affinity ⇒ ::Google::Cloud::Compute::V1::TargetPool::SessionAffinity
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.

Instance Attribute Details

#backup_pool ⇒ `::String`

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

Returns:

(::String) —
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.

# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 13449

class TargetPool
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # 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.
  module SessionAffinity
    # A value indicating that the enum field is not set.
    UNDEFINED_SESSION_AFFINITY = 0

    CLIENT_IP = 345665051

    CLIENT_IP_PORT_PROTO = 221722926

    CLIENT_IP_PROTO = 25322148

    GENERATED_COOKIE = 370321204

    HEADER_FIELD = 200737960

    HTTP_COOKIE = 494981627

    NONE = 2402104
  end
end

#creation_timestamp ⇒ `::String`

Returns [Output Only] Creation timestamp in RFC3339 text format.

Returns:

(::String) —
[Output Only] Creation timestamp in RFC3339 text format.

# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 13449

class TargetPool
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # 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.
  module SessionAffinity
    # A value indicating that the enum field is not set.
    UNDEFINED_SESSION_AFFINITY = 0

    CLIENT_IP = 345665051

    CLIENT_IP_PORT_PROTO = 221722926

    CLIENT_IP_PROTO = 25322148

    GENERATED_COOKIE = 370321204

    HEADER_FIELD = 200737960

    HTTP_COOKIE = 494981627

    NONE = 2402104
  end
end

#description ⇒ `::String`

Returns An optional description of this resource. Provide this property when you create the resource.

Returns:

(::String) —
An optional description of this resource. Provide this property when you create the resource.

# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 13449

class TargetPool
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # 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.
  module SessionAffinity
    # A value indicating that the enum field is not set.
    UNDEFINED_SESSION_AFFINITY = 0

    CLIENT_IP = 345665051

    CLIENT_IP_PORT_PROTO = 221722926

    CLIENT_IP_PROTO = 25322148

    GENERATED_COOKIE = 370321204

    HEADER_FIELD = 200737960

    HTTP_COOKIE = 494981627

    NONE = 2402104
  end
end

#failover_ratio ⇒ `::Float`

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

Returns:

(::Float) —
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.

# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 13449

class TargetPool
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # 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.
  module SessionAffinity
    # A value indicating that the enum field is not set.
    UNDEFINED_SESSION_AFFINITY = 0

    CLIENT_IP = 345665051

    CLIENT_IP_PORT_PROTO = 221722926

    CLIENT_IP_PROTO = 25322148

    GENERATED_COOKIE = 370321204

    HEADER_FIELD = 200737960

    HTTP_COOKIE = 494981627

    NONE = 2402104
  end
end

#health_checks ⇒ `::Array<::String>`

Returns The URL of the HttpHealthCheck resource. A member instance in this pool is considered healthy if and only if the health checks pass. An empty list means all member instances will be considered healthy at all times. Only legacy HttpHealthChecks are supported. Only one health check may be specified.

Returns:

(::Array<::String>) —
The URL of the HttpHealthCheck resource. A member instance in this pool is considered healthy if and only if the health checks pass. An empty list means all member instances will be considered healthy at all times. Only legacy HttpHealthChecks are supported. Only one health check may be specified.

# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 13449

class TargetPool
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # 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.
  module SessionAffinity
    # A value indicating that the enum field is not set.
    UNDEFINED_SESSION_AFFINITY = 0

    CLIENT_IP = 345665051

    CLIENT_IP_PORT_PROTO = 221722926

    CLIENT_IP_PROTO = 25322148

    GENERATED_COOKIE = 370321204

    HEADER_FIELD = 200737960

    HTTP_COOKIE = 494981627

    NONE = 2402104
  end
end

#id ⇒ `::String`

Returns [Output Only] The unique identifier for the resource. This identifier is defined by the server.

Returns:

(::String) —
[Output Only] The unique identifier for the resource. This identifier is defined by the server.

# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 13449

class TargetPool
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # 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.
  module SessionAffinity
    # A value indicating that the enum field is not set.
    UNDEFINED_SESSION_AFFINITY = 0

    CLIENT_IP = 345665051

    CLIENT_IP_PORT_PROTO = 221722926

    CLIENT_IP_PROTO = 25322148

    GENERATED_COOKIE = 370321204

    HEADER_FIELD = 200737960

    HTTP_COOKIE = 494981627

    NONE = 2402104
  end
end

#instances ⇒ `::Array<::String>`

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

Returns:

(::Array<::String>) —
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.

# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 13449

class TargetPool
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # 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.
  module SessionAffinity
    # A value indicating that the enum field is not set.
    UNDEFINED_SESSION_AFFINITY = 0

    CLIENT_IP = 345665051

    CLIENT_IP_PORT_PROTO = 221722926

    CLIENT_IP_PROTO = 25322148

    GENERATED_COOKIE = 370321204

    HEADER_FIELD = 200737960

    HTTP_COOKIE = 494981627

    NONE = 2402104
  end
end

#kind ⇒ `::String`

Returns [Output Only] Type of the resource. Always compute#targetPool for target pools.

Returns:

(::String) —
[Output Only] Type of the resource. Always compute#targetPool for target pools.

# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 13449

class TargetPool
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # 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.
  module SessionAffinity
    # A value indicating that the enum field is not set.
    UNDEFINED_SESSION_AFFINITY = 0

    CLIENT_IP = 345665051

    CLIENT_IP_PORT_PROTO = 221722926

    CLIENT_IP_PROTO = 25322148

    GENERATED_COOKIE = 370321204

    HEADER_FIELD = 200737960

    HTTP_COOKIE = 494981627

    NONE = 2402104
  end
end

#name ⇒ `::String`

Returns 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]([-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.

Returns:

(::String) —
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]([-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.

# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 13449

class TargetPool
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # 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.
  module SessionAffinity
    # A value indicating that the enum field is not set.
    UNDEFINED_SESSION_AFFINITY = 0

    CLIENT_IP = 345665051

    CLIENT_IP_PORT_PROTO = 221722926

    CLIENT_IP_PROTO = 25322148

    GENERATED_COOKIE = 370321204

    HEADER_FIELD = 200737960

    HTTP_COOKIE = 494981627

    NONE = 2402104
  end
end

#region ⇒ `::String`

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

Returns:

(::String) —
[Output Only] URL of the region where the target pool resides.

# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 13449

class TargetPool
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # 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.
  module SessionAffinity
    # A value indicating that the enum field is not set.
    UNDEFINED_SESSION_AFFINITY = 0

    CLIENT_IP = 345665051

    CLIENT_IP_PORT_PROTO = 221722926

    CLIENT_IP_PROTO = 25322148

    GENERATED_COOKIE = 370321204

    HEADER_FIELD = 200737960

    HTTP_COOKIE = 494981627

    NONE = 2402104
  end
end

#self_link ⇒ `::String`

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

Returns:

(::String) —
[Output Only] Server-defined URL for the resource.

# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 13449

class TargetPool
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # 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.
  module SessionAffinity
    # A value indicating that the enum field is not set.
    UNDEFINED_SESSION_AFFINITY = 0

    CLIENT_IP = 345665051

    CLIENT_IP_PORT_PROTO = 221722926

    CLIENT_IP_PROTO = 25322148

    GENERATED_COOKIE = 370321204

    HEADER_FIELD = 200737960

    HTTP_COOKIE = 494981627

    NONE = 2402104
  end
end

#session_affinity ⇒ `::Google::Cloud::Compute::V1::TargetPool::SessionAffinity`

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

Returns:

(::Google::Cloud::Compute::V1::TargetPool::SessionAffinity) —
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.

# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 13449

class TargetPool
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # 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.
  module SessionAffinity
    # A value indicating that the enum field is not set.
    UNDEFINED_SESSION_AFFINITY = 0

    CLIENT_IP = 345665051

    CLIENT_IP_PORT_PROTO = 221722926

    CLIENT_IP_PROTO = 25322148

    GENERATED_COOKIE = 370321204

    HEADER_FIELD = 200737960

    HTTP_COOKIE = 494981627

    NONE = 2402104
  end
end

Class: Google::Cloud::Compute::V1::TargetPool

Overview

Defined Under Namespace

Instance Attribute Summary collapse

Instance Attribute Details

#backup_pool ⇒ ::String

#creation_timestamp ⇒ ::String

#description ⇒ ::String

#failover_ratio ⇒ ::Float

#health_checks ⇒ ::Array<::String>

#id ⇒ ::String

#instances ⇒ ::Array<::String>

#kind ⇒ ::String

#name ⇒ ::String

#region ⇒ ::String

#self_link ⇒ ::String

#session_affinity ⇒ ::Google::Cloud::Compute::V1::TargetPool::SessionAffinity

#backup_pool ⇒ `::String`

#creation_timestamp ⇒ `::String`

#description ⇒ `::String`

#failover_ratio ⇒ `::Float`

#health_checks ⇒ `::Array<::String>`

#id ⇒ `::String`

#instances ⇒ `::Array<::String>`

#kind ⇒ `::String`

#name ⇒ `::String`

#region ⇒ `::String`

#self_link ⇒ `::String`

#session_affinity ⇒ `::Google::Cloud::Compute::V1::TargetPool::SessionAffinity`