Class: Google::Apis::ComputeV1::TargetPool

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
lib/google/apis/compute_v1/classes.rb,
lib/google/apis/compute_v1/representations.rb,
lib/google/apis/compute_v1/representations.rb

Overview

Represents a Target Pool resource. Target pools are used with external passthrough Network Load Balancers. A target pool references member instances, an associated legacy HttpHealthCheck resource, and, optionally, a backup target pool. For more information, readUsing target pools.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ TargetPool

Returns a new instance of TargetPool.



64014
64015
64016
 
# File 'lib/google/apis/compute_v1/classes.rb', line 64014

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 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. Corresponds to the JSON property backupPool

Returns:

  • (String) 


63917
63918
63919
 
# File 'lib/google/apis/compute_v1/classes.rb', line 63917

def backup_pool
  @backup_pool
end

#creation_timestamp ⇒ String

Output only. [Output Only] Creation timestamp inRFC3339 text format. Corresponds to the JSON property creationTimestamp

Returns:

  • (String) 


63923
63924
63925
 
# File 'lib/google/apis/compute_v1/classes.rb', line 63923

def creation_timestamp
  @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

Returns:

  • (String) 


63929
63930
63931
 
# File 'lib/google/apis/compute_v1/classes.rb', line 63929

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

Returns:

  • (Float) 


63946
63947
63948
 
# File 'lib/google/apis/compute_v1/classes.rb', line 63946

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

Returns:

  • (Array<String>) 


63954
63955
63956
 
# File 'lib/google/apis/compute_v1/classes.rb', line 63954

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

Returns:

  • (Fixnum) 


63960
63961
63962
 
# File 'lib/google/apis/compute_v1/classes.rb', line 63960

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

Returns:

  • (Array<String>) 


63966
63967
63968
 
# File 'lib/google/apis/compute_v1/classes.rb', line 63966

def instances
  @instances
end

#kind ⇒ String

Output only. [Output Only] Type of the resource. Always compute#targetPool for target pools. Corresponds to the JSON property kind

Returns:

  • (String) 


63972
63973
63974
 
# File 'lib/google/apis/compute_v1/classes.rb', line 63972

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 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. Corresponds to the JSON property name

Returns:

  • (String) 


63983
63984
63985
 
# File 'lib/google/apis/compute_v1/classes.rb', line 63983

def name
  @name
end

#region ⇒ String

Output only. [Output Only] URL of the region where the target pool resides. Corresponds to the JSON property region

Returns:

  • (String) 


63988
63989
63990
 
# File 'lib/google/apis/compute_v1/classes.rb', line 63988

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

Returns:

  • (String) 


63994
63995
63996
 
# File 'lib/google/apis/compute_v1/classes.rb', line 63994

def security_policy
  @security_policy
end

#self_link ⇒ String

[Output Only] Server-defined URL for the resource. Corresponds to the JSON property selfLink

Returns:

  • (String) 


63999
64000
64001
 
# File 'lib/google/apis/compute_v1/classes.rb', line 63999

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

Returns:

  • (String) 


64012
64013
64014
 
# File 'lib/google/apis/compute_v1/classes.rb', line 64012

def session_affinity
  @session_affinity
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



64019
64020
64021
64022
64023
64024
64025
64026
64027
64028
64029
64030
64031
64032
64033
 
# File 'lib/google/apis/compute_v1/classes.rb', line 64019

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)
  @session_affinity = args[:session_affinity] if args.key?(:session_affinity)
end