Class: Google::Apis::ComputeV1::TargetPool
- Inherits:
-
Object
- Object
- Google::Apis::ComputeV1::TargetPool
- Defined in:
- generated/google/apis/compute_v1/classes.rb,
generated/google/apis/compute_v1/representations.rb,
generated/google/apis/compute_v1/representations.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 beta.targetPools ==) (== resource_for v1.targetPools == )
Instance Attribute Summary collapse
-
#backup_pool ⇒ String
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].
-
#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 ⇒ Fixnum
[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 ⇒ String
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 Method Summary collapse
-
#initialize(**args) ⇒ TargetPool
constructor
A new instance of TargetPool.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Google::Apis::Core::JsonObjectSupport
Methods included from Google::Apis::Core::Hashable
Constructor Details
#initialize(**args) ⇒ TargetPool
Returns a new instance of TargetPool
23864 23865 23866 |
# File 'generated/google/apis/compute_v1/classes.rb', line 23864 def initialize(**args) update!(**args) end |
Instance Attribute Details
#backup_pool ⇒ String
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.
Corresponds to the JSON property backupPool
23781 23782 23783 |
# File 'generated/google/apis/compute_v1/classes.rb', line 23781 def backup_pool @backup_pool end |
#creation_timestamp ⇒ String
[Output Only] Creation timestamp in RFC3339 text format.
Corresponds to the JSON property creationTimestamp
23786 23787 23788 |
# File 'generated/google/apis/compute_v1/classes.rb', line 23786 def @creation_timestamp end |
#description ⇒ String
An optional description of this resource. Provide this property when you
create the resource.
Corresponds to the JSON property description
23792 23793 23794 |
# File 'generated/google/apis/compute_v1/classes.rb', line 23792 def description @description end |
#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). 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.
Corresponds to the JSON property failoverRatio
23807 23808 23809 |
# File 'generated/google/apis/compute_v1/classes.rb', line 23807 def failover_ratio @failover_ratio end |
#health_checks ⇒ 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
HttpHealthChecks are supported. Only one health check may be specified.
Corresponds to the JSON property healthChecks
23815 23816 23817 |
# File 'generated/google/apis/compute_v1/classes.rb', line 23815 def health_checks @health_checks end |
#id ⇒ Fixnum
[Output Only] The unique identifier for the resource. This identifier is
defined by the server.
Corresponds to the JSON property id
23821 23822 23823 |
# File 'generated/google/apis/compute_v1/classes.rb', line 23821 def id @id end |
#instances ⇒ 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.
Corresponds to the JSON property instances
23827 23828 23829 |
# File 'generated/google/apis/compute_v1/classes.rb', line 23827 def instances @instances end |
#kind ⇒ String
[Output Only] Type of the resource. Always compute#targetPool for target pools.
Corresponds to the JSON property kind
23832 23833 23834 |
# File 'generated/google/apis/compute_v1/classes.rb', line 23832 def kind @kind end |
#name ⇒ 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.
Corresponds to the JSON property name
23842 23843 23844 |
# File 'generated/google/apis/compute_v1/classes.rb', line 23842 def name @name end |
#region ⇒ String
[Output Only] URL of the region where the target pool resides.
Corresponds to the JSON property region
23847 23848 23849 |
# File 'generated/google/apis/compute_v1/classes.rb', line 23847 def region @region end |
#self_link ⇒ String
[Output Only] Server-defined URL for the resource.
Corresponds to the JSON property selfLink
23852 23853 23854 |
# File 'generated/google/apis/compute_v1/classes.rb', line 23852 def self_link @self_link end |
#session_affinity ⇒ String
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.
Corresponds to the JSON property sessionAffinity
23862 23863 23864 |
# File 'generated/google/apis/compute_v1/classes.rb', line 23862 def session_affinity @session_affinity end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
23869 23870 23871 23872 23873 23874 23875 23876 23877 23878 23879 23880 23881 23882 |
# File 'generated/google/apis/compute_v1/classes.rb', line 23869 def update!(**args) @backup_pool = args[:backup_pool] if args.key?(:backup_pool) @creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp) @description = args[:description] if args.key?(:description) @failover_ratio = args[:failover_ratio] if args.key?(:failover_ratio) @health_checks = args[:health_checks] if args.key?(:health_checks) @id = args[:id] if args.key?(:id) @instances = args[:instances] if args.key?(:instances) @kind = args[:kind] if args.key?(:kind) @name = args[:name] if args.key?(:name) @region = args[:region] if args.key?(:region) @self_link = args[:self_link] if args.key?(:self_link) @session_affinity = args[:session_affinity] if args.key?(:session_affinity) end |