- 1.92.0 (latest)
- 1.91.0
- 1.90.0
- 1.88.0
- 1.86.0
- 1.85.0
- 1.84.0
- 1.83.0
- 1.82.0
- 1.80.0
- 1.78.0
- 1.77.0
- 1.74.0
- 1.73.0
- 1.72.0
- 1.70.0
- 1.69.0
- 1.68.0
- 1.67.0
- 1.66.0
- 1.65.0
- 1.64.0
- 1.63.0
- 1.62.0
- 1.61.0
- 1.59.0
- 1.58.0
- 1.57.0
- 1.56.0
- 1.55.0
- 1.54.0
- 1.53.0
- 1.52.0
- 1.51.0
- 1.50.0
- 1.49.0
- 1.47.0
- 1.46.0
- 1.45.0
- 1.44.0
- 1.43.0
- 1.42.0
- 1.41.0
- 1.40.0
- 1.39.0
- 1.38.0
- 1.37.0
- 1.34.0
- 1.33.0
- 1.32.0
- 1.31.0
- 1.30.0
- 1.29.0
- 1.28.0
- 1.27.0
- 1.26.0
- 1.25.0
- 1.24.0
- 1.23.0
- 1.22.0
- 1.21.0
- 1.20.0
- 1.19.0
- 1.18.0
- 1.17.0
- 1.16.0
- 1.15.0
- 1.14.0
- 1.13.0
- 1.12.1
- 1.11.0
- 1.9.1
- 1.8.1
- 1.7.2
- 1.6.0-beta
public static final class BackendServiceFailoverPolicy.Builder extends GeneratedMessage.Builder<BackendServiceFailoverPolicy.Builder> implements BackendServiceFailoverPolicyOrBuilderFor 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
Inheritance
java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > BackendServiceFailoverPolicy.BuilderImplements
BackendServiceFailoverPolicyOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
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 |
|
clearDisableConnectionDrainOnFailover()
public BackendServiceFailoverPolicy.Builder clearDisableConnectionDrainOnFailover()This can be set to true only if the protocol isTCP.
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. |
getDefaultInstanceForType()
public BackendServiceFailoverPolicy getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
BackendServiceFailoverPolicy |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
getDisableConnectionDrainOnFailover()
public boolean getDisableConnectionDrainOnFailover()This can be set to true only if the protocol isTCP.
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 isTCP.
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 GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
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 |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public BackendServiceFailoverPolicy.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
BackendServiceFailoverPolicy.Builder |
|
setDisableConnectionDrainOnFailover(boolean value)
public BackendServiceFailoverPolicy.Builder setDisableConnectionDrainOnFailover(boolean value)This can be set to true only if the protocol isTCP.
The default is false.
optional bool disable_connection_drain_on_failover = 182150753;
| Parameter | |
|---|---|
| Name | Description |
value |
booleanThe 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 |
booleanThe 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 |
floatThe failoverRatio to set. |
| Returns | |
|---|---|
| Type | Description |
BackendServiceFailoverPolicy.Builder |
This builder for chaining. |