Class BackendServiceFailoverPolicy.Builder (1.57.0)

public static final class BackendServiceFailoverPolicy.Builder extends GeneratedMessageV3.Builder<BackendServiceFailoverPolicy.Builder> implements BackendServiceFailoverPolicyOrBuilder

For load balancers that have configurable failover: Internal passthrough Network Load Balancers and external passthrough Network Load Balancers. 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 Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public BackendServiceFailoverPolicy.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
BackendServiceFailoverPolicy.Builder
Overrides

build()

public BackendServiceFailoverPolicy build()
Returns
Type Description
BackendServiceFailoverPolicy

buildPartial()

public BackendServiceFailoverPolicy buildPartial()
Returns
Type Description
BackendServiceFailoverPolicy

clear()

public BackendServiceFailoverPolicy.Builder clear()
Returns
Type Description
BackendServiceFailoverPolicy.Builder
Overrides

clearDisableConnectionDrainOnFailover()

public BackendServiceFailoverPolicy.Builder clearDisableConnectionDrainOnFailover()

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
Type Description
BackendServiceFailoverPolicy.Builder

This builder for chaining.

clearDropTrafficIfUnhealthy()

public BackendServiceFailoverPolicy.Builder clearDropTrafficIfUnhealthy()

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 and external passthrough Network Load Balancers. The default is false.

optional bool drop_traffic_if_unhealthy = 112289428;

Returns
Type Description
BackendServiceFailoverPolicy.Builder

This builder for chaining.

clearFailoverRatio()

public BackendServiceFailoverPolicy.Builder clearFailoverRatio()

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
Type Description
BackendServiceFailoverPolicy.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public BackendServiceFailoverPolicy.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
BackendServiceFailoverPolicy.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public BackendServiceFailoverPolicy.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
BackendServiceFailoverPolicy.Builder
Overrides

clone()

public BackendServiceFailoverPolicy.Builder clone()
Returns
Type Description
BackendServiceFailoverPolicy.Builder
Overrides

getDefaultInstanceForType()

public BackendServiceFailoverPolicy getDefaultInstanceForType()
Returns
Type Description
BackendServiceFailoverPolicy

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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
Type Description
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 passthrough Network Load Balancers and external passthrough Network Load Balancers. The default is false.

optional bool drop_traffic_if_unhealthy = 112289428;

Returns
Type Description
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
Type Description
float

The failoverRatio.

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
Type Description
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 passthrough Network Load Balancers and external passthrough Network Load Balancers. The default is false.

optional bool drop_traffic_if_unhealthy = 112289428;

Returns
Type Description
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
Type Description
boolean

Whether the failoverRatio field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(BackendServiceFailoverPolicy other)

public BackendServiceFailoverPolicy.Builder mergeFrom(BackendServiceFailoverPolicy other)
Parameter
Name Description
other BackendServiceFailoverPolicy
Returns
Type Description
BackendServiceFailoverPolicy.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public BackendServiceFailoverPolicy.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BackendServiceFailoverPolicy.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public BackendServiceFailoverPolicy.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
BackendServiceFailoverPolicy.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final BackendServiceFailoverPolicy.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
BackendServiceFailoverPolicy.Builder
Overrides

setDisableConnectionDrainOnFailover(boolean value)

public BackendServiceFailoverPolicy.Builder setDisableConnectionDrainOnFailover(boolean value)

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

optional bool disable_connection_drain_on_failover = 182150753;

Parameter
Name Description
value boolean

The disableConnectionDrainOnFailover to set.

Returns
Type Description
BackendServiceFailoverPolicy.Builder

This builder for chaining.

setDropTrafficIfUnhealthy(boolean value)

public BackendServiceFailoverPolicy.Builder setDropTrafficIfUnhealthy(boolean value)

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 and external passthrough Network Load Balancers. The default is false.

optional bool drop_traffic_if_unhealthy = 112289428;

Parameter
Name Description
value boolean

The dropTrafficIfUnhealthy to set.

Returns
Type Description
BackendServiceFailoverPolicy.Builder

This builder for chaining.

setFailoverRatio(float value)

public BackendServiceFailoverPolicy.Builder setFailoverRatio(float value)

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;

Parameter
Name Description
value float

The failoverRatio to set.

Returns
Type Description
BackendServiceFailoverPolicy.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public BackendServiceFailoverPolicy.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
BackendServiceFailoverPolicy.Builder
Overrides

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public BackendServiceFailoverPolicy.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
BackendServiceFailoverPolicy.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final BackendServiceFailoverPolicy.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
BackendServiceFailoverPolicy.Builder
Overrides