com.google.api.services.compute.model

Class BackendServiceFailoverPolicy

java.lang.Object

java.util.AbstractMap<java.lang.String,java.lang.Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

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

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>

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

Model definition for BackendServiceFailoverPolicy.

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

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

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

java.util.Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
BackendServiceFailoverPolicy()

Method Summary

Modifier and Type	Method and Description
BackendServiceFailoverPolicy	clone()
java.lang.Boolean	getDisableConnectionDrainOnFailover() On failover or failback, this field indicates whether connection drain will be honored.
java.lang.Boolean	getDropTrafficIfUnhealthy() This option is used only when no healthy VMs are detected in the primary and backup instance groups.
java.lang.Float	getFailoverRatio() The value of the field must be in [0, 1].
BackendServiceFailoverPolicy	set(java.lang.String fieldName, java.lang.Object value)
BackendServiceFailoverPolicy	setDisableConnectionDrainOnFailover(java.lang.Boolean disableConnectionDrainOnFailover) On failover or failback, this field indicates whether connection drain will be honored.
BackendServiceFailoverPolicy	setDropTrafficIfUnhealthy(java.lang.Boolean dropTrafficIfUnhealthy) This option is used only when no healthy VMs are detected in the primary and backup instance groups.
BackendServiceFailoverPolicy	setFailoverRatio(java.lang.Float failoverRatio) The value of the field must be in [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, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, equals, hashCode, 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 java.lang.Boolean getDisableConnectionDrainOnFailover()

On failover or failback, this field indicates whether connection drain will be honored. Setting this to true has the following effect: connections to the old active pool are not drained. Connections to the new active pool use the timeout of 10 min (currently fixed). Setting to false has the following effect: both old and new connections will have a drain timeout of 10 min. 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(java.lang.Boolean disableConnectionDrainOnFailover)

On failover or failback, this field indicates whether connection drain will be honored. Setting this to true has the following effect: connections to the old active pool are not drained. Connections to the new active pool use the timeout of 10 min (currently fixed). Setting to false has the following effect: both old and new connections will have a drain timeout of 10 min. 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 java.lang.Boolean getDropTrafficIfUnhealthy()

This option is used only when no healthy VMs are detected in the primary and backup instance groups. When set to true, traffic is dropped. When set to false, new connections are sent across all VMs in the primary group. The default is false.

Returns:

value or null for none

setDropTrafficIfUnhealthy

public BackendServiceFailoverPolicy setDropTrafficIfUnhealthy(java.lang.Boolean dropTrafficIfUnhealthy)

This option is used only when no healthy VMs are detected in the primary and backup instance groups. When set to true, traffic is dropped. When set to false, new connections are sent across all VMs in the primary group. The default is false.

Parameters:

dropTrafficIfUnhealthy - dropTrafficIfUnhealthy or null for none

getFailoverRatio

public java.lang.Float getFailoverRatio()

The value of the field must be in [0, 1]. If the ratio of the healthy VMs in the primary backend is at or below this number, traffic arriving at the load-balanced IP will be directed to the failover backend. In case where 'failoverRatio' is not set or all the VMs in the backup backend are unhealthy, the traffic will be directed back to the primary backend in the "force" mode, where traffic will be spread to the healthy VMs with the best effort, or to all VMs when no VM is healthy. This field is only used with l4 load balancing.

Returns:

value or null for none

setFailoverRatio

public BackendServiceFailoverPolicy setFailoverRatio(java.lang.Float failoverRatio)

The value of the field must be in [0, 1]. If the ratio of the healthy VMs in the primary backend is at or below this number, traffic arriving at the load-balanced IP will be directed to the failover backend. In case where 'failoverRatio' is not set or all the VMs in the backup backend are unhealthy, the traffic will be directed back to the primary backend in the "force" mode, where traffic will be spread to the healthy VMs with the best effort, or to all VMs when no VM is healthy. This field is only used with l4 load balancing.

Parameters:

failoverRatio - failoverRatio or null for none

set

public BackendServiceFailoverPolicy set(java.lang.String fieldName,
                                        java.lang.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