Class BackendServiceFailoverPolicy (1.31.0)

public final class BackendServiceFailoverPolicy extends GeneratedMessageV3 implements BackendServiceFailoverPolicyOrBuilder

For load balancers that have configurable failover: Internal TCP/UDP Load Balancing and external TCP/UDP Load Balancing. 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).

Protobuf type google.cloud.compute.v1.BackendServiceFailoverPolicy

Static Fields

DISABLE_CONNECTION_DRAIN_ON_FAILOVER_FIELD_NUMBER

public static final int DISABLE_CONNECTION_DRAIN_ON_FAILOVER_FIELD_NUMBER
Field Value
TypeDescription
int

DROP_TRAFFIC_IF_UNHEALTHY_FIELD_NUMBER

public static final int DROP_TRAFFIC_IF_UNHEALTHY_FIELD_NUMBER
Field Value
TypeDescription
int

FAILOVER_RATIO_FIELD_NUMBER

public static final int FAILOVER_RATIO_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static BackendServiceFailoverPolicy getDefaultInstance()
Returns
TypeDescription
BackendServiceFailoverPolicy

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static BackendServiceFailoverPolicy.Builder newBuilder()
Returns
TypeDescription
BackendServiceFailoverPolicy.Builder

newBuilder(BackendServiceFailoverPolicy prototype)

public static BackendServiceFailoverPolicy.Builder newBuilder(BackendServiceFailoverPolicy prototype)
Parameter
NameDescription
prototypeBackendServiceFailoverPolicy
Returns
TypeDescription
BackendServiceFailoverPolicy.Builder

parseDelimitedFrom(InputStream input)

public static BackendServiceFailoverPolicy parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
BackendServiceFailoverPolicy
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static BackendServiceFailoverPolicy parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
BackendServiceFailoverPolicy
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static BackendServiceFailoverPolicy parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
BackendServiceFailoverPolicy
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static BackendServiceFailoverPolicy parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
BackendServiceFailoverPolicy
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static BackendServiceFailoverPolicy parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
BackendServiceFailoverPolicy
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static BackendServiceFailoverPolicy parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
BackendServiceFailoverPolicy
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static BackendServiceFailoverPolicy parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
BackendServiceFailoverPolicy
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static BackendServiceFailoverPolicy parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
BackendServiceFailoverPolicy
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static BackendServiceFailoverPolicy parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
BackendServiceFailoverPolicy
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static BackendServiceFailoverPolicy parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
BackendServiceFailoverPolicy
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static BackendServiceFailoverPolicy parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
BackendServiceFailoverPolicy
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static BackendServiceFailoverPolicy parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
BackendServiceFailoverPolicy
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<BackendServiceFailoverPolicy> parser()
Returns
TypeDescription
Parser<BackendServiceFailoverPolicy>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public BackendServiceFailoverPolicy getDefaultInstanceForType()
Returns
TypeDescription
BackendServiceFailoverPolicy

getDisableConnectionDrainOnFailover()

public boolean getDisableConnectionDrainOnFailover()

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

optional bool disable_connection_drain_on_failover = 182150753;

Returns
TypeDescription
boolean

The disableConnectionDrainOnFailover.

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 TCP/UDP Load Balancing and external TCP/UDP Load Balancing. The default is false.

optional bool drop_traffic_if_unhealthy = 112289428;

Returns
TypeDescription
boolean

The dropTrafficIfUnhealthy.

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 and external TCP/UDP Load Balancing.

optional float failover_ratio = 212667006;

Returns
TypeDescription
float

The failoverRatio.

getParserForType()

public Parser<BackendServiceFailoverPolicy> getParserForType()
Returns
TypeDescription
Parser<BackendServiceFailoverPolicy>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

hasDisableConnectionDrainOnFailover()

public boolean hasDisableConnectionDrainOnFailover()

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

optional bool disable_connection_drain_on_failover = 182150753;

Returns
TypeDescription
boolean

Whether the disableConnectionDrainOnFailover field is set.

hasDropTrafficIfUnhealthy()

public boolean hasDropTrafficIfUnhealthy()

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 TCP/UDP Load Balancing and external TCP/UDP Load Balancing. The default is false.

optional bool drop_traffic_if_unhealthy = 112289428;

Returns
TypeDescription
boolean

Whether the dropTrafficIfUnhealthy field is set.

hasFailoverRatio()

public boolean hasFailoverRatio()

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 and external TCP/UDP Load Balancing.

optional float failover_ratio = 212667006;

Returns
TypeDescription
boolean

Whether the failoverRatio field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public BackendServiceFailoverPolicy.Builder newBuilderForType()
Returns
TypeDescription
BackendServiceFailoverPolicy.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected BackendServiceFailoverPolicy.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
BackendServiceFailoverPolicy.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public BackendServiceFailoverPolicy.Builder toBuilder()
Returns
TypeDescription
BackendServiceFailoverPolicy.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException