Class: Google::Apis::ComputeAlpha::TargetPool
- Inherits:
-
Object
- Object
- Google::Apis::ComputeAlpha::TargetPool
- Includes:
- Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
- Defined in:
- lib/google/apis/compute_alpha/classes.rb,
lib/google/apis/compute_alpha/representations.rb,
lib/google/apis/compute_alpha/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.
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 ⇒ 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.
-
#security_policy ⇒ String
[Output Only] The resource URL for the security policy associated with this target pool.
-
#self_link ⇒ String
[Output Only] Server-defined URL for the resource.
-
#self_link_with_id ⇒ String
[Output Only] Server-defined URL for this resource with the resource id.
-
#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.
Constructor Details
#initialize(**args) ⇒ TargetPool
Returns a new instance of TargetPool.
47887 47888 47889 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 47887 def initialize(**args) update!(**args) end |
Instance Attribute Details
#backup_pool ⇒ 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.
Corresponds to the JSON property backupPool
47794 47795 47796 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 47794 def backup_pool @backup_pool end |
#creation_timestamp ⇒ String
[Output Only] Creation timestamp in RFC3339 text format.
Corresponds to the JSON property creationTimestamp
47799 47800 47801 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 47799 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
47805 47806 47807 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 47805 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
47820 47821 47822 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 47820 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. Only legacy
HttpHealthChecks are supported. Only one health check may be specified.
Corresponds to the JSON property healthChecks
47827 47828 47829 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 47827 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
47833 47834 47835 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 47833 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
47839 47840 47841 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 47839 def instances @instances end |
#kind ⇒ String
[Output Only] Type of the resource. Always compute#targetPool for target pools.
Corresponds to the JSON property kind
47844 47845 47846 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 47844 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
47854 47855 47856 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 47854 def name @name end |
#region ⇒ String
[Output Only] URL of the region where the target pool resides.
Corresponds to the JSON property region
47859 47860 47861 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 47859 def region @region end |
#security_policy ⇒ String
[Output Only] The resource URL for the security policy associated with this
target pool.
Corresponds to the JSON property securityPolicy
47865 47866 47867 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 47865 def security_policy @security_policy end |
#self_link ⇒ String
[Output Only] Server-defined URL for the resource.
Corresponds to the JSON property selfLink
47870 47871 47872 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 47870 def self_link @self_link end |
#self_link_with_id ⇒ String
[Output Only] Server-defined URL for this resource with the resource id.
Corresponds to the JSON property selfLinkWithId
47875 47876 47877 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 47875 def self_link_with_id @self_link_with_id 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
47885 47886 47887 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 47885 def session_affinity @session_affinity end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
47892 47893 47894 47895 47896 47897 47898 47899 47900 47901 47902 47903 47904 47905 47906 47907 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 47892 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) @security_policy = args[:security_policy] if args.key?(:security_policy) @self_link = args[:self_link] if args.key?(:self_link) @self_link_with_id = args[:self_link_with_id] if args.key?(:self_link_with_id) @session_affinity = args[:session_affinity] if args.key?(:session_affinity) end |