Reference documentation and code samples for the Compute V1 Client class BackendServiceFailoverPolicy.
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).
Generated from protobuf message google.cloud.compute.v1.BackendServiceFailoverPolicy
Namespace
Google \ Cloud \ Compute \ V1
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ disable_connection_drain_on_failover
bool
This can be set to true only if the protocol is TCP. The default is false.
↳ drop_traffic_if_unhealthy
bool
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.
↳ failover_ratio
float
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.
getDisableConnectionDrainOnFailover
This can be set to true only if the protocol is TCP. The default is false.
Returns
Type
Description
bool
hasDisableConnectionDrainOnFailover
clearDisableConnectionDrainOnFailover
setDisableConnectionDrainOnFailover
This can be set to true only if the protocol is TCP. The default is false.
Parameter
Name
Description
var
bool
Returns
Type
Description
$this
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.
Returns
Type
Description
bool
hasDropTrafficIfUnhealthy
clearDropTrafficIfUnhealthy
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 and external passthrough Network Load Balancers. The default is false.
Parameter
Name
Description
var
bool
Returns
Type
Description
$this
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.
Returns
Type
Description
float
hasFailoverRatio
clearFailoverRatio
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 and external TCP/UDP Load Balancing.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-28 UTC."],[],[],null,["# Compute V1 Client - Class BackendServiceFailoverPolicy (1.35.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.35.0 (latest)](/php/docs/reference/cloud-compute/latest/V1.BackendServiceFailoverPolicy)\n- [1.34.0](/php/docs/reference/cloud-compute/1.34.0/V1.BackendServiceFailoverPolicy)\n- [1.33.0](/php/docs/reference/cloud-compute/1.33.0/V1.BackendServiceFailoverPolicy)\n- [1.32.0](/php/docs/reference/cloud-compute/1.32.0/V1.BackendServiceFailoverPolicy)\n- [1.31.0](/php/docs/reference/cloud-compute/1.31.0/V1.BackendServiceFailoverPolicy)\n- [1.30.0](/php/docs/reference/cloud-compute/1.30.0/V1.BackendServiceFailoverPolicy)\n- [1.29.0](/php/docs/reference/cloud-compute/1.29.0/V1.BackendServiceFailoverPolicy)\n- [1.28.0](/php/docs/reference/cloud-compute/1.28.0/V1.BackendServiceFailoverPolicy)\n- [1.27.0](/php/docs/reference/cloud-compute/1.27.0/V1.BackendServiceFailoverPolicy)\n- [1.26.0](/php/docs/reference/cloud-compute/1.26.0/V1.BackendServiceFailoverPolicy)\n- [1.25.0](/php/docs/reference/cloud-compute/1.25.0/V1.BackendServiceFailoverPolicy)\n- [1.24.0](/php/docs/reference/cloud-compute/1.24.0/V1.BackendServiceFailoverPolicy)\n- [1.23.0](/php/docs/reference/cloud-compute/1.23.0/V1.BackendServiceFailoverPolicy)\n- [1.22.1](/php/docs/reference/cloud-compute/1.22.1/V1.BackendServiceFailoverPolicy)\n- [1.21.0](/php/docs/reference/cloud-compute/1.21.0/V1.BackendServiceFailoverPolicy)\n- [1.20.0](/php/docs/reference/cloud-compute/1.20.0/V1.BackendServiceFailoverPolicy)\n- [1.19.0](/php/docs/reference/cloud-compute/1.19.0/V1.BackendServiceFailoverPolicy)\n- [1.18.1](/php/docs/reference/cloud-compute/1.18.1/V1.BackendServiceFailoverPolicy)\n- [1.17.0](/php/docs/reference/cloud-compute/1.17.0/V1.BackendServiceFailoverPolicy)\n- [1.16.2](/php/docs/reference/cloud-compute/1.16.2/V1.BackendServiceFailoverPolicy)\n- [1.14.0](/php/docs/reference/cloud-compute/1.14.0/V1.BackendServiceFailoverPolicy)\n- [1.13.0](/php/docs/reference/cloud-compute/1.13.0/V1.BackendServiceFailoverPolicy)\n- [1.12.1](/php/docs/reference/cloud-compute/1.12.1/V1.BackendServiceFailoverPolicy)\n- [1.11.1](/php/docs/reference/cloud-compute/1.11.1/V1.BackendServiceFailoverPolicy)\n- [1.10.1](/php/docs/reference/cloud-compute/1.10.1/V1.BackendServiceFailoverPolicy)\n- [1.9.1](/php/docs/reference/cloud-compute/1.9.1/V1.BackendServiceFailoverPolicy)\n- [1.8.3](/php/docs/reference/cloud-compute/1.8.3/V1.BackendServiceFailoverPolicy)\n- [1.7.1](/php/docs/reference/cloud-compute/1.7.1/V1.BackendServiceFailoverPolicy)\n- [1.6.1](/php/docs/reference/cloud-compute/1.6.1/V1.BackendServiceFailoverPolicy)\n- [1.5.0](/php/docs/reference/cloud-compute/1.5.0/V1.BackendServiceFailoverPolicy) \nReference documentation and code samples for the Compute V1 Client class BackendServiceFailoverPolicy.\n\nFor 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).\n\nGenerated from protobuf message `google.cloud.compute.v1.BackendServiceFailoverPolicy`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Compute \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getDisableConnectionDrainOnFailover\n\nThis can be set to true only if the protocol is TCP. The default is false.\n\n### hasDisableConnectionDrainOnFailover\n\n### clearDisableConnectionDrainOnFailover\n\n### setDisableConnectionDrainOnFailover\n\nThis can be set to true only if the protocol is TCP. The default is false.\n\n### getDropTrafficIfUnhealthy\n\nIf 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.\n\n### hasDropTrafficIfUnhealthy\n\n### clearDropTrafficIfUnhealthy\n\n### setDropTrafficIfUnhealthy\n\nIf 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.\n\n### getFailoverRatio\n\nThe 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).\n\n### hasFailoverRatio\n\n### clearFailoverRatio\n\n### setFailoverRatio\n\nThe 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)."]]
