Package com.google.cloud.compute.v1
Class BackendServiceFailoverPolicy.Builder
java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<BackendServiceFailoverPolicy.Builder>
com.google.cloud.compute.v1.BackendServiceFailoverPolicy.Builder
- All Implemented Interfaces:
BackendServiceFailoverPolicyOrBuilder,com.google.protobuf.Message.Builder,com.google.protobuf.MessageLite.Builder,com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder,Cloneable
- Enclosing class:
- BackendServiceFailoverPolicy
public static final class BackendServiceFailoverPolicy.Builder
extends com.google.protobuf.GeneratedMessage.Builder<BackendServiceFailoverPolicy.Builder>
implements BackendServiceFailoverPolicyOrBuilder
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).Protobuf type
google.cloud.compute.v1.BackendServiceFailoverPolicy-
Method Summary
Modifier and TypeMethodDescriptionbuild()clear()This can be set to true if the protocol isTCP, UDP, or UNSPECIFIED.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 value of the field must be in the range[0, 1].static final com.google.protobuf.Descriptors.Descriptorcom.google.protobuf.Descriptors.DescriptorbooleanThis can be set to true if the protocol isTCP, UDP, or UNSPECIFIED.booleanIf 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.floatThe value of the field must be in the range[0, 1].booleanThis can be set to true if the protocol isTCP, UDP, or UNSPECIFIED.booleanIf 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.booleanThe value of the field must be in the range[0, 1].protected com.google.protobuf.GeneratedMessage.FieldAccessorTablefinal booleanmergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) mergeFrom(com.google.protobuf.Message other) setDisableConnectionDrainOnFailover(boolean value) This can be set to true if the protocol isTCP, UDP, or UNSPECIFIED.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.setFailoverRatio(float value) The value of the field must be in the range[0, 1].Methods inherited from class com.google.protobuf.GeneratedMessage.Builder
addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, setUnknownFieldSetBuilder, setUnknownFieldsProto3Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringMethods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageExceptionMethods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.protobuf.Message.Builder
mergeDelimitedFrom, mergeDelimitedFromMethods inherited from interface com.google.protobuf.MessageLite.Builder
mergeFromMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Method Details
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessage.Builder<BackendServiceFailoverPolicy.Builder>
-
clear
- Specified by:
clearin interfacecom.google.protobuf.Message.Builder- Specified by:
clearin interfacecom.google.protobuf.MessageLite.Builder- Overrides:
clearin classcom.google.protobuf.GeneratedMessage.Builder<BackendServiceFailoverPolicy.Builder>
-
getDescriptorForType
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.Message.Builder- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.MessageOrBuilder- Overrides:
getDescriptorForTypein classcom.google.protobuf.GeneratedMessage.Builder<BackendServiceFailoverPolicy.Builder>
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-
build
- Specified by:
buildin interfacecom.google.protobuf.Message.Builder- Specified by:
buildin interfacecom.google.protobuf.MessageLite.Builder
-
buildPartial
- Specified by:
buildPartialin interfacecom.google.protobuf.Message.Builder- Specified by:
buildPartialin interfacecom.google.protobuf.MessageLite.Builder
-
mergeFrom
- Specified by:
mergeFromin interfacecom.google.protobuf.Message.Builder- Overrides:
mergeFromin classcom.google.protobuf.AbstractMessage.Builder<BackendServiceFailoverPolicy.Builder>
-
mergeFrom
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessage.Builder<BackendServiceFailoverPolicy.Builder>
-
mergeFrom
public BackendServiceFailoverPolicy.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Specified by:
mergeFromin interfacecom.google.protobuf.Message.Builder- Specified by:
mergeFromin interfacecom.google.protobuf.MessageLite.Builder- Overrides:
mergeFromin classcom.google.protobuf.AbstractMessage.Builder<BackendServiceFailoverPolicy.Builder>- Throws:
IOException
-
hasDisableConnectionDrainOnFailover
public boolean hasDisableConnectionDrainOnFailover()This can be set to true if the protocol isTCP, UDP, or UNSPECIFIED. The default is false.
optional bool disable_connection_drain_on_failover = 182150753;- Specified by:
hasDisableConnectionDrainOnFailoverin interfaceBackendServiceFailoverPolicyOrBuilder- Returns:
- Whether the disableConnectionDrainOnFailover field is set.
-
getDisableConnectionDrainOnFailover
public boolean getDisableConnectionDrainOnFailover()This can be set to true if the protocol isTCP, UDP, or UNSPECIFIED. The default is false.
optional bool disable_connection_drain_on_failover = 182150753;- Specified by:
getDisableConnectionDrainOnFailoverin interfaceBackendServiceFailoverPolicyOrBuilder- Returns:
- The disableConnectionDrainOnFailover.
-
setDisableConnectionDrainOnFailover
This can be set to true if the protocol isTCP, UDP, or UNSPECIFIED. The default is false.
optional bool disable_connection_drain_on_failover = 182150753;- Parameters:
value- The disableConnectionDrainOnFailover to set.- Returns:
- This builder for chaining.
-
clearDisableConnectionDrainOnFailover
This can be set to true if the protocol isTCP, UDP, or UNSPECIFIED. The default is false.
optional bool disable_connection_drain_on_failover = 182150753;- Returns:
- This builder for chaining.
-
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](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.
optional bool drop_traffic_if_unhealthy = 112289428;- Specified by:
hasDropTrafficIfUnhealthyin interfaceBackendServiceFailoverPolicyOrBuilder- Returns:
- Whether the dropTrafficIfUnhealthy field is set.
-
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.
optional bool drop_traffic_if_unhealthy = 112289428;- Specified by:
getDropTrafficIfUnhealthyin interfaceBackendServiceFailoverPolicyOrBuilder- Returns:
- The dropTrafficIfUnhealthy.
-
setDropTrafficIfUnhealthy
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.
optional bool drop_traffic_if_unhealthy = 112289428;- Parameters:
value- The dropTrafficIfUnhealthy to set.- Returns:
- This builder for chaining.
-
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](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.
optional bool drop_traffic_if_unhealthy = 112289428;- Returns:
- This builder for chaining.
-
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](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).
optional float failover_ratio = 212667006;- Specified by:
hasFailoverRatioin interfaceBackendServiceFailoverPolicyOrBuilder- Returns:
- Whether the failoverRatio field is set.
-
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).
optional float failover_ratio = 212667006;- Specified by:
getFailoverRatioin interfaceBackendServiceFailoverPolicyOrBuilder- Returns:
- The failoverRatio.
-
setFailoverRatio
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).
optional float failover_ratio = 212667006;- Parameters:
value- The failoverRatio to set.- Returns:
- This builder for chaining.
-
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](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).
optional float failover_ratio = 212667006;- Returns:
- This builder for chaining.
-