Struct BackendServiceFailoverPolicy 

#[non_exhaustive]
pub struct BackendServiceFailoverPolicy {
    pub disable_connection_drain_on_failover: Option<bool>,
    pub drop_traffic_if_unhealthy: Option<bool>,
    pub failover_ratio: Option<f32>,
    /* private fields */
}

Available on crate features backend-services or region-backend-services only.

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).

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

disable_connection_drain_on_failover: Option<bool>

This can be set to true only if the protocol isTCP.

The default is false.

drop_traffic_if_unhealthy: Option<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: Option<f32>

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.

Implementations

impl BackendServiceFailoverPolicy

pub fn new() -> Self

pub fn set_disable_connection_drain_on_failover<T>(self, v: T) -> Self

where T: Into<bool>,

Sets the value of disable_connection_drain_on_failover.

Example

let x = BackendServiceFailoverPolicy::new().set_disable_connection_drain_on_failover(true);

pub fn set_or_clear_disable_connection_drain_on_failover<T>( self, v: Option<T>, ) -> Self

where T: Into<bool>,

Sets or clears the value of disable_connection_drain_on_failover.

Example

let x = BackendServiceFailoverPolicy::new().set_or_clear_disable_connection_drain_on_failover(Some(false));
let x = BackendServiceFailoverPolicy::new().set_or_clear_disable_connection_drain_on_failover(None::<bool>);

pub fn set_drop_traffic_if_unhealthy<T>(self, v: T) -> Self

where T: Into<bool>,

Sets the value of drop_traffic_if_unhealthy.

Example

let x = BackendServiceFailoverPolicy::new().set_drop_traffic_if_unhealthy(true);

pub fn set_or_clear_drop_traffic_if_unhealthy<T>(self, v: Option<T>) -> Self

where T: Into<bool>,

Sets or clears the value of drop_traffic_if_unhealthy.

Example

let x = BackendServiceFailoverPolicy::new().set_or_clear_drop_traffic_if_unhealthy(Some(false));
let x = BackendServiceFailoverPolicy::new().set_or_clear_drop_traffic_if_unhealthy(None::<bool>);

pub fn set_failover_ratio<T>(self, v: T) -> Self

where T: Into<f32>,

Sets the value of failover_ratio.

Example

let x = BackendServiceFailoverPolicy::new().set_failover_ratio(42.0);

pub fn set_or_clear_failover_ratio<T>(self, v: Option<T>) -> Self

where T: Into<f32>,

Sets or clears the value of failover_ratio.

Example

let x = BackendServiceFailoverPolicy::new().set_or_clear_failover_ratio(Some(42.0));
let x = BackendServiceFailoverPolicy::new().set_or_clear_failover_ratio(None::<f32>);

Trait Implementations

impl Clone for BackendServiceFailoverPolicy

fn clone(&self) -> BackendServiceFailoverPolicy

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for BackendServiceFailoverPolicy

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for BackendServiceFailoverPolicy

fn default() -> BackendServiceFailoverPolicy

Returns the “default value” for a type.

impl Message for BackendServiceFailoverPolicy

fn typename() -> &'static str

The typename of this message.

impl PartialEq for BackendServiceFailoverPolicy

fn eq(&self, other: &BackendServiceFailoverPolicy) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for BackendServiceFailoverPolicy