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
A TargetPool resource. This resource defines a pool of instances, associated HttpHealthCheck resources, and the fallback target pool.
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>
A list of URLs to 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 ⇒ String
Sesssion 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.
8967 8968 8969 |
# File 'generated/google/apis/compute_v1/classes.rb', line 8967 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
8885 8886 8887 |
# File 'generated/google/apis/compute_v1/classes.rb', line 8885 def backup_pool @backup_pool end |
#creation_timestamp ⇒ String
[Output Only] Creation timestamp in RFC3339 text format.
Corresponds to the JSON property creationTimestamp
8890 8891 8892 |
# File 'generated/google/apis/compute_v1/classes.rb', line 8890 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
8896 8897 8898 |
# File 'generated/google/apis/compute_v1/classes.rb', line 8896 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
8911 8912 8913 |
# File 'generated/google/apis/compute_v1/classes.rb', line 8911 def failover_ratio @failover_ratio end |
#health_checks ⇒ Array<String>
A list of URLs to the HttpHealthCheck resource. A member instance in this pool
is considered healthy if and only if all specified health checks pass. An
empty list means all member instances will be considered healthy at all times.
Corresponds to the JSON property healthChecks
8918 8919 8920 |
# File 'generated/google/apis/compute_v1/classes.rb', line 8918 def health_checks @health_checks end |
#id ⇒ String
[Output Only] The unique identifier for the resource. This identifier is
defined by the server.
Corresponds to the JSON property id
8924 8925 8926 |
# File 'generated/google/apis/compute_v1/classes.rb', line 8924 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
8930 8931 8932 |
# File 'generated/google/apis/compute_v1/classes.rb', line 8930 def instances @instances end |
#kind ⇒ String
[Output Only] Type of the resource. Always compute#targetPool for target pools.
Corresponds to the JSON property kind
8935 8936 8937 |
# File 'generated/google/apis/compute_v1/classes.rb', line 8935 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? 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
8945 8946 8947 |
# File 'generated/google/apis/compute_v1/classes.rb', line 8945 def name @name end |
#region ⇒ String
[Output Only] URL of the region where the target pool resides.
Corresponds to the JSON property region
8950 8951 8952 |
# File 'generated/google/apis/compute_v1/classes.rb', line 8950 def region @region end |
#self_link ⇒ String
[Output Only] Server-defined URL for the resource.
Corresponds to the JSON property selfLink
8955 8956 8957 |
# File 'generated/google/apis/compute_v1/classes.rb', line 8955 def self_link @self_link end |
#session_affinity ⇒ String
Sesssion 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
8965 8966 8967 |
# File 'generated/google/apis/compute_v1/classes.rb', line 8965 def session_affinity @session_affinity end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
8972 8973 8974 8975 8976 8977 8978 8979 8980 8981 8982 8983 8984 8985 |
# File 'generated/google/apis/compute_v1/classes.rb', line 8972 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 |