Struct BackendCustomMetric 

#[non_exhaustive]
pub struct BackendCustomMetric {
    pub dry_run: Option<bool>,
    pub max_utilization: Option<f32>,
    pub name: Option<String>,
    /* private fields */
}

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

Custom Metrics are used for CUSTOM_METRICS balancing_mode.

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.

dry_run: Option<bool>

If true, the metric data is collected and reported to Cloud Monitoring, but is not used for load balancing.

max_utilization: Option<f32>

Optional parameter to define a target utilization for the Custom Metrics balancing mode. The valid range is [0.0, 1.0].

name: Option<String>

Name of a custom utilization signal. The name must be 1-64 characters long and match the regular expression [a-z]([-_.a-z0-9]*[a-z0-9])? which means that the first character must be a lowercase letter, and all following characters must be a dash, period, underscore, lowercase letter, or digit, except the last character, which cannot be a dash, period, or underscore. For usage guidelines, see Custom Metrics balancing mode. This field can only be used for a global or regional backend service with the loadBalancingScheme set to EXTERNAL_MANAGED,INTERNAL_MANAGED INTERNAL_SELF_MANAGED.

Implementations

impl BackendCustomMetric

pub fn new() -> Self

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

where T: Into<bool>,

Sets the value of dry_run.

Example

let x = BackendCustomMetric::new().set_dry_run(true);

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

where T: Into<bool>,

Sets or clears the value of dry_run.

Example

let x = BackendCustomMetric::new().set_or_clear_dry_run(Some(false));
let x = BackendCustomMetric::new().set_or_clear_dry_run(None::<bool>);

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

where T: Into<f32>,

Sets the value of max_utilization.

Example

let x = BackendCustomMetric::new().set_max_utilization(42.0);

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

where T: Into<f32>,

Sets or clears the value of max_utilization.

Example

let x = BackendCustomMetric::new().set_or_clear_max_utilization(Some(42.0));
let x = BackendCustomMetric::new().set_or_clear_max_utilization(None::<f32>);

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

where T: Into<String>,

Sets the value of name.

Example

let x = BackendCustomMetric::new().set_name("example");

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

where T: Into<String>,

Sets or clears the value of name.

Example

let x = BackendCustomMetric::new().set_or_clear_name(Some("example"));
let x = BackendCustomMetric::new().set_or_clear_name(None::<String>);

Trait Implementations

impl Clone for BackendCustomMetric

fn clone(&self) -> BackendCustomMetric

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BackendCustomMetric

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

Formats the value using the given formatter.

impl Default for BackendCustomMetric

fn default() -> BackendCustomMetric

Returns the “default value” for a type.

impl Message for BackendCustomMetric

fn typename() -> &'static str

The typename of this message.

impl PartialEq for BackendCustomMetric

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