com.google.api.services.compute.model

Class BackendServiceFailoverPolicy

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.compute.model.BackendServiceFailoverPolicy

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class BackendServiceFailoverPolicy
extends com.google.api.client.json.GenericJson

For load balancers that have configurable failover: [Internal passthrough Network Load Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview) and [external passthrough Network Load Balancers](https://cloud.google.com/load- balancing/docs/network/networklb-failover-overview). On failover or failback, this field indicates whether connection draining will be honored. Google Cloud 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).

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Compute Engine API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
BackendServiceFailoverPolicy()

Method Summary

Modifier and Type	Method and Description
BackendServiceFailoverPolicy	clone()
Boolean	getDisableConnectionDrainOnFailover() This can be set to true only if the protocol is TCP.
Boolean	getDropTrafficIfUnhealthy() 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.
Float	getFailoverRatio() The value of the field must be in the range [0, 1].
BackendServiceFailoverPolicy	set(String fieldName, Object value)
BackendServiceFailoverPolicy	setDisableConnectionDrainOnFailover(Boolean disableConnectionDrainOnFailover) This can be set to true only if the protocol is TCP.
BackendServiceFailoverPolicy	setDropTrafficIfUnhealthy(Boolean dropTrafficIfUnhealthy) 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.
BackendServiceFailoverPolicy	setFailoverRatio(Float failoverRatio) The value of the field must be in the range [0, 1].

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

BackendServiceFailoverPolicy

public BackendServiceFailoverPolicy()

Method Detail

getDisableConnectionDrainOnFailover

public Boolean getDisableConnectionDrainOnFailover()

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

Returns:

value or null for none

setDisableConnectionDrainOnFailover

public BackendServiceFailoverPolicy setDisableConnectionDrainOnFailover(Boolean disableConnectionDrainOnFailover)

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

Parameters:

disableConnectionDrainOnFailover - disableConnectionDrainOnFailover or null for none

getDropTrafficIfUnhealthy

public Boolean getDropTrafficIfUnhealthy()

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. For load balancers that have configurable failover: [Internal passthrough Network Load Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview) and [external passthrough Network Load Balancers](https://cloud.google.com/load- balancing/docs/network/networklb-failover-overview). The default is false.

Returns:

value or null for none

setDropTrafficIfUnhealthy

public BackendServiceFailoverPolicy setDropTrafficIfUnhealthy(Boolean dropTrafficIfUnhealthy)

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. For load balancers that have configurable failover: [Internal passthrough Network Load Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview) and [external passthrough Network Load Balancers](https://cloud.google.com/load- balancing/docs/network/networklb-failover-overview). The default is false.

Parameters:

dropTrafficIfUnhealthy - dropTrafficIfUnhealthy or null for none

getFailoverRatio

public Float getFailoverRatio()

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. For load balancers that have configurable failover: [Internal TCP/UDP Load Balancing](https://cloud.google.com/load-balancing/docs/internal/failover-overview) and [external TCP/UDP Load Balancing](https://cloud.google.com/load- balancing/docs/network/networklb-failover-overview).

Returns:

value or null for none

setFailoverRatio

public BackendServiceFailoverPolicy setFailoverRatio(Float failoverRatio)

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. For load balancers that have configurable failover: [Internal TCP/UDP Load Balancing](https://cloud.google.com/load-balancing/docs/internal/failover-overview) and [external TCP/UDP Load Balancing](https://cloud.google.com/load- balancing/docs/network/networklb-failover-overview).

Parameters:

failoverRatio - failoverRatio or null for none

set

public BackendServiceFailoverPolicy set(String fieldName,
                                        Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public BackendServiceFailoverPolicy clone()

Overrides:

clone in class com.google.api.client.json.GenericJson