Class: Google::Apis::ComputeV1::BackendServiceFailoverPolicy

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

Overview

Applicable only to Failover for Internal TCP/UDP Load Balancing and Network Load Balancing. On failover or failback, this field indicates whether connection draining will be honored. GCP has a fixed connection draining timeout of 10 minutes. A setting of true terminates existing TCP connections to the active pool during failover and failback, immediately draining traffic. A setting of false allows existing TCP connections to persist, even on VMs no longer in the active pool, for up to the duration of the connection draining timeout (10 minutes).

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ BackendServiceFailoverPolicy

Returns a new instance of BackendServiceFailoverPolicy.



3348
3349
3350
 
# File 'generated/google/apis/compute_v1/classes.rb', line 3348

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#disable_connection_drain_on_failover ⇒ Boolean Also known as: disable_connection_drain_on_failover?

This can be set to true only if the protocol is TCP. The default is false. Corresponds to the JSON property disableConnectionDrainOnFailover

Returns:

  • (Boolean) 


3326
3327
3328
 
# File 'generated/google/apis/compute_v1/classes.rb', line 3326

def disable_connection_drain_on_failover
  @disable_connection_drain_on_failover
end

#drop_traffic_if_unhealthy ⇒ Boolean Also known as: drop_traffic_if_unhealthy?

Applicable only to Failover for Internal TCP/UDP Load Balancing and Network Load Balancing, If set to true, connections to the load balancer are dropped when all primary and all backup backend VMs are unhealthy.If set to false, connections are distributed among all primary VMs when all primary and all backup backend VMs are unhealthy. The default is false. Corresponds to the JSON property dropTrafficIfUnhealthy

Returns:

  • (Boolean) 


3336
3337
3338
 
# File 'generated/google/apis/compute_v1/classes.rb', line 3336

def drop_traffic_if_unhealthy
  @drop_traffic_if_unhealthy
end

#failover_ratio ⇒ Float

Applicable only to Failover for Internal TCP/UDP Load Balancing and Network Load Balancing. The value of the field must be in the range [0, 1]. If the value is 0, the load balancer performs a failover when the number of healthy primary VMs equals zero. For all other values, the load balancer performs a failover when the total number of healthy primary VMs is less than this ratio. Corresponds to the JSON property failoverRatio

Returns:

  • (Float) 


3346
3347
3348
 
# File 'generated/google/apis/compute_v1/classes.rb', line 3346

def failover_ratio
  @failover_ratio
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3353
3354
3355
3356
3357
 
# File 'generated/google/apis/compute_v1/classes.rb', line 3353

def update!(**args)
  @disable_connection_drain_on_failover = args[:disable_connection_drain_on_failover] if args.key?(:disable_connection_drain_on_failover)
  @drop_traffic_if_unhealthy = args[:drop_traffic_if_unhealthy] if args.key?(:drop_traffic_if_unhealthy)
  @failover_ratio = args[:failover_ratio] if args.key?(:failover_ratio)
end