Struct OutlierDetection 

#[non_exhaustive]
pub struct OutlierDetection {
    pub base_ejection_time: Option<Duration>,
    pub consecutive_errors: Option<i32>,
    pub consecutive_gateway_failure: Option<i32>,
    pub enforcing_consecutive_errors: Option<i32>,
    pub enforcing_consecutive_gateway_failure: Option<i32>,
    pub enforcing_success_rate: Option<i32>,
    pub interval: Option<Duration>,
    pub max_ejection_percent: Option<i32>,
    pub success_rate_minimum_hosts: Option<i32>,
    pub success_rate_request_volume: Option<i32>,
    pub success_rate_stdev_factor: Option<i32>,
    /* private fields */
}

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

Settings controlling the eviction of unhealthy hosts from the load balancing pool for the backend service.

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.

base_ejection_time: Option<Duration>

The base time that a backend endpoint is ejected for. Defaults to 30000ms or 30s.

After a backend endpoint is returned back to the load balancing pool, it can be ejected again in another ejection analysis. Thus, the total ejection time is equal to the base ejection time multiplied by the number of times the backend endpoint has been ejected. Defaults to 30000ms or 30s.

consecutive_errors: Option<i32>

Number of consecutive errors before a backend endpoint is ejected from the load balancing pool. When the backend endpoint is accessed over HTTP, a 5xx return code qualifies as an error. Defaults to 5.

consecutive_gateway_failure: Option<i32>

The number of consecutive gateway failures (502, 503, 504 status or connection errors that are mapped to one of those status codes) before a consecutive gateway failure ejection occurs. Defaults to 3.

enforcing_consecutive_errors: Option<i32>

The percentage chance that a backend endpoint will be ejected when an outlier status is detected through consecutive 5xx. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 0.

enforcing_consecutive_gateway_failure: Option<i32>

The percentage chance that a backend endpoint will be ejected when an outlier status is detected through consecutive gateway failures. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100.

enforcing_success_rate: Option<i32>

The percentage chance that a backend endpoint will be ejected when an outlier status is detected through success rate statistics. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100.

Not supported when the backend service uses Serverless NEG.

interval: Option<Duration>

Time interval between ejection analysis sweeps. This can result in both new ejections and backend endpoints being returned to service. The interval is equal to the number of seconds as defined in outlierDetection.interval.seconds plus the number of nanoseconds as defined in outlierDetection.interval.nanos. Defaults to 1 second.

max_ejection_percent: Option<i32>

Maximum percentage of backend endpoints in the load balancing pool for the backend service that can be ejected if the ejection conditions are met. Defaults to 50%.

success_rate_minimum_hosts: Option<i32>

The number of backend endpoints in the load balancing pool that must have enough request volume to detect success rate outliers. If the number of backend endpoints is fewer than this setting, outlier detection via success rate statistics is not performed for any backend endpoint in the load balancing pool. Defaults to 5.

Not supported when the backend service uses Serverless NEG.

success_rate_request_volume: Option<i32>

The minimum number of total requests that must be collected in one interval (as defined by the interval duration above) to include this backend endpoint in success rate based outlier detection. If the volume is lower than this setting, outlier detection via success rate statistics is not performed for that backend endpoint. Defaults to 100.

Not supported when the backend service uses Serverless NEG.

success_rate_stdev_factor: Option<i32>

This factor is used to determine the ejection threshold for success rate outlier ejection. The ejection threshold is the difference between the mean success rate, and the product of this factor and the standard deviation of the mean success rate: mean - (stdev * successRateStdevFactor). This factor is divided by a thousand to get a double. That is, if the desired factor is 1.9, the runtime value should be 1900. Defaults to 1900.

Not supported when the backend service uses Serverless NEG.

Implementations

impl OutlierDetection

pub fn new() -> Self

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

where T: Into<Duration>,

Sets the value of base_ejection_time.

Example

use google_cloud_compute_v1::model::Duration;
let x = OutlierDetection::new().set_base_ejection_time(Duration::default()/* use setters */);

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

where T: Into<Duration>,

Sets or clears the value of base_ejection_time.

Example

use google_cloud_compute_v1::model::Duration;
let x = OutlierDetection::new().set_or_clear_base_ejection_time(Some(Duration::default()/* use setters */));
let x = OutlierDetection::new().set_or_clear_base_ejection_time(None::<Duration>);

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

where T: Into<i32>,

Sets the value of consecutive_errors.

Example

let x = OutlierDetection::new().set_consecutive_errors(42);

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

where T: Into<i32>,

Sets or clears the value of consecutive_errors.

Example

let x = OutlierDetection::new().set_or_clear_consecutive_errors(Some(42));
let x = OutlierDetection::new().set_or_clear_consecutive_errors(None::<i32>);

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

where T: Into<i32>,

Sets the value of consecutive_gateway_failure.

Example

let x = OutlierDetection::new().set_consecutive_gateway_failure(42);

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

where T: Into<i32>,

Sets or clears the value of consecutive_gateway_failure.

Example

let x = OutlierDetection::new().set_or_clear_consecutive_gateway_failure(Some(42));
let x = OutlierDetection::new().set_or_clear_consecutive_gateway_failure(None::<i32>);

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

where T: Into<i32>,

Sets the value of enforcing_consecutive_errors.

Example

let x = OutlierDetection::new().set_enforcing_consecutive_errors(42);

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

where T: Into<i32>,

Sets or clears the value of enforcing_consecutive_errors.

Example

let x = OutlierDetection::new().set_or_clear_enforcing_consecutive_errors(Some(42));
let x = OutlierDetection::new().set_or_clear_enforcing_consecutive_errors(None::<i32>);

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

where T: Into<i32>,

Sets the value of enforcing_consecutive_gateway_failure.

Example

let x = OutlierDetection::new().set_enforcing_consecutive_gateway_failure(42);

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

where T: Into<i32>,

Sets or clears the value of enforcing_consecutive_gateway_failure.

Example

let x = OutlierDetection::new().set_or_clear_enforcing_consecutive_gateway_failure(Some(42));
let x = OutlierDetection::new().set_or_clear_enforcing_consecutive_gateway_failure(None::<i32>);

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

where T: Into<i32>,

Sets the value of enforcing_success_rate.

Example

let x = OutlierDetection::new().set_enforcing_success_rate(42);

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

where T: Into<i32>,

Sets or clears the value of enforcing_success_rate.

Example

let x = OutlierDetection::new().set_or_clear_enforcing_success_rate(Some(42));
let x = OutlierDetection::new().set_or_clear_enforcing_success_rate(None::<i32>);

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

where T: Into<Duration>,

Sets the value of interval.

Example

use google_cloud_compute_v1::model::Duration;
let x = OutlierDetection::new().set_interval(Duration::default()/* use setters */);

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

where T: Into<Duration>,

Sets or clears the value of interval.

Example

use google_cloud_compute_v1::model::Duration;
let x = OutlierDetection::new().set_or_clear_interval(Some(Duration::default()/* use setters */));
let x = OutlierDetection::new().set_or_clear_interval(None::<Duration>);

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

where T: Into<i32>,

Sets the value of max_ejection_percent.

Example

let x = OutlierDetection::new().set_max_ejection_percent(42);

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

where T: Into<i32>,

Sets or clears the value of max_ejection_percent.

Example

let x = OutlierDetection::new().set_or_clear_max_ejection_percent(Some(42));
let x = OutlierDetection::new().set_or_clear_max_ejection_percent(None::<i32>);

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

where T: Into<i32>,

Sets the value of success_rate_minimum_hosts.

Example

let x = OutlierDetection::new().set_success_rate_minimum_hosts(42);

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

where T: Into<i32>,

Sets or clears the value of success_rate_minimum_hosts.

Example

let x = OutlierDetection::new().set_or_clear_success_rate_minimum_hosts(Some(42));
let x = OutlierDetection::new().set_or_clear_success_rate_minimum_hosts(None::<i32>);

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

where T: Into<i32>,

Sets the value of success_rate_request_volume.

Example

let x = OutlierDetection::new().set_success_rate_request_volume(42);

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

where T: Into<i32>,

Sets or clears the value of success_rate_request_volume.

Example

let x = OutlierDetection::new().set_or_clear_success_rate_request_volume(Some(42));
let x = OutlierDetection::new().set_or_clear_success_rate_request_volume(None::<i32>);

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

where T: Into<i32>,

Sets the value of success_rate_stdev_factor.

Example

let x = OutlierDetection::new().set_success_rate_stdev_factor(42);

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

where T: Into<i32>,

Sets or clears the value of success_rate_stdev_factor.

Example

let x = OutlierDetection::new().set_or_clear_success_rate_stdev_factor(Some(42));
let x = OutlierDetection::new().set_or_clear_success_rate_stdev_factor(None::<i32>);

Trait Implementations

impl Clone for OutlierDetection

fn clone(&self) -> OutlierDetection

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OutlierDetection

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

Formats the value using the given formatter.

impl Default for OutlierDetection

fn default() -> OutlierDetection

Returns the “default value” for a type.

impl Message for OutlierDetection

fn typename() -> &'static str

The typename of this message.

impl PartialEq for OutlierDetection

fn eq(&self, other: &OutlierDetection) -> 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 OutlierDetection