Skip to main content

HealthAggregationPolicy

Struct HealthAggregationPolicy 

Source
#[non_exhaustive]
pub struct HealthAggregationPolicy { pub creation_timestamp: Option<String>, pub description: Option<String>, pub fingerprint: Option<Bytes>, pub healthy_percent_threshold: Option<u32>, pub id: Option<u64>, pub kind: Option<String>, pub min_healthy_threshold: Option<u32>, pub name: Option<String>, pub policy_type: Option<PolicyType>, pub region: Option<String>, pub self_link: Option<String>, pub self_link_with_id: Option<String>, /* private fields */ }
Available on crate feature region-health-aggregation-policies only.
Expand description

Represents a health aggregation policy.

A health aggregation policy resource defines a policy to aggregate health.

For more information, see Health checks overview.

Fields (Non-exhaustive)§

This struct is marked as 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.
§creation_timestamp: Option<String>

Output only. [Output Only] Creation timestamp inRFC3339 text format.

§description: Option<String>

An optional description of this resource. Provide this property when you create the resource.

§fingerprint: Option<Bytes>

Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a HealthAggregationPolicy. An up-to-date fingerprint must be provided in order to patch the HealthAggregationPolicy; Otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the HealthAggregationPolicy.

§healthy_percent_threshold: Option<u32>

Can only be set if the policyType field isBACKEND_SERVICE_POLICY. Specifies the threshold (as a percentage) of healthy endpoints required in order to consider the aggregated health result HEALTHY. Defaults to 60. Must be in range [0, 100]. Not applicable if the policyType field isDNB_PUBLIC_IP_POLICY. Can be mutated. This field is optional, and will be set to the default if unspecified. Note that both this threshold and minHealthyThreshold must be satisfied in order for HEALTHY to be the aggregated result. “Endpoints” refers to network endpoints within a Network Endpoint Group or instances within an Instance Group.

§id: Option<u64>

Output only. [Output Only] The unique identifier for the resource. This identifier is defined by the server.

§kind: Option<String>

Output only. [Output Only] Type of the resource. Alwayscompute#healthAggregationPolicy for health aggregation policies.

§min_healthy_threshold: Option<u32>

Can only be set if the policyType field isBACKEND_SERVICE_POLICY. Specifies the minimum number of healthy endpoints required in order to consider the aggregated health result HEALTHY. Defaults to 1. Must be positive. Not applicable if the policyType field isDNB_PUBLIC_IP_POLICY. Can be mutated. This field is optional, and will be set to the default if unspecified. Note that both this threshold and healthyPercentThreshold must be satisfied in order for HEALTHY to be the aggregated result. “Endpoints” refers to network endpoints within a Network Endpoint Group or instances within an Instance Group.

§name: Option<String>

Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply withRFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

§policy_type: Option<PolicyType>

Specifies the type of the healthAggregationPolicy. The only allowed value for global resources is DNS_PUBLIC_IP_POLICY. The only allowed value for regional resources is BACKEND_SERVICE_POLICY. Must be specified when the healthAggregationPolicy is created, and cannot be mutated.

§region: Option<String>

Output only. [Output Only] URL of the region where the health aggregation policy resides. This field applies only to the regional resource. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

§self_link: Option<String>

Output only. [Output Only] Server-defined URL for the resource.

§self_link_with_id: Option<String>

Output only. [Output Only] Server-defined URL with id for the resource.

Implementations§

Source§

impl HealthAggregationPolicy

Source

pub fn new() -> Self

Source

pub fn set_creation_timestamp<T>(self, v: T) -> Self
where T: Into<String>,

Sets the value of creation_timestamp.

§Example
let x = HealthAggregationPolicy::new().set_creation_timestamp("example");
Source

pub fn set_or_clear_creation_timestamp<T>(self, v: Option<T>) -> Self
where T: Into<String>,

Sets or clears the value of creation_timestamp.

§Example
let x = HealthAggregationPolicy::new().set_or_clear_creation_timestamp(Some("example"));
let x = HealthAggregationPolicy::new().set_or_clear_creation_timestamp(None::<String>);
Source

pub fn set_description<T>(self, v: T) -> Self
where T: Into<String>,

Sets the value of description.

§Example
let x = HealthAggregationPolicy::new().set_description("example");
Source

pub fn set_or_clear_description<T>(self, v: Option<T>) -> Self
where T: Into<String>,

Sets or clears the value of description.

§Example
let x = HealthAggregationPolicy::new().set_or_clear_description(Some("example"));
let x = HealthAggregationPolicy::new().set_or_clear_description(None::<String>);
Source

pub fn set_fingerprint<T>(self, v: T) -> Self
where T: Into<Bytes>,

Sets the value of fingerprint.

§Example
let x = HealthAggregationPolicy::new().set_fingerprint(bytes::Bytes::from_static(b"example"));
Source

pub fn set_or_clear_fingerprint<T>(self, v: Option<T>) -> Self
where T: Into<Bytes>,

Sets or clears the value of fingerprint.

§Example
let x = HealthAggregationPolicy::new().set_or_clear_fingerprint(Some(bytes::Bytes::from_static(b"example")));
let x = HealthAggregationPolicy::new().set_or_clear_fingerprint(None::<bytes::Bytes>);
Source

pub fn set_healthy_percent_threshold<T>(self, v: T) -> Self
where T: Into<u32>,

Sets the value of healthy_percent_threshold.

§Example
let x = HealthAggregationPolicy::new().set_healthy_percent_threshold(42_u32);
Source

pub fn set_or_clear_healthy_percent_threshold<T>(self, v: Option<T>) -> Self
where T: Into<u32>,

Sets or clears the value of healthy_percent_threshold.

§Example
let x = HealthAggregationPolicy::new().set_or_clear_healthy_percent_threshold(Some(42_u32));
let x = HealthAggregationPolicy::new().set_or_clear_healthy_percent_threshold(None::<u32>);
Source

pub fn set_id<T>(self, v: T) -> Self
where T: Into<u64>,

Sets the value of id.

§Example
let x = HealthAggregationPolicy::new().set_id(42_u32);
Source

pub fn set_or_clear_id<T>(self, v: Option<T>) -> Self
where T: Into<u64>,

Sets or clears the value of id.

§Example
let x = HealthAggregationPolicy::new().set_or_clear_id(Some(42_u32));
let x = HealthAggregationPolicy::new().set_or_clear_id(None::<u32>);
Source

pub fn set_kind<T>(self, v: T) -> Self
where T: Into<String>,

Sets the value of kind.

§Example
let x = HealthAggregationPolicy::new().set_kind("example");
Source

pub fn set_or_clear_kind<T>(self, v: Option<T>) -> Self
where T: Into<String>,

Sets or clears the value of kind.

§Example
let x = HealthAggregationPolicy::new().set_or_clear_kind(Some("example"));
let x = HealthAggregationPolicy::new().set_or_clear_kind(None::<String>);
Source

pub fn set_min_healthy_threshold<T>(self, v: T) -> Self
where T: Into<u32>,

Sets the value of min_healthy_threshold.

§Example
let x = HealthAggregationPolicy::new().set_min_healthy_threshold(42_u32);
Source

pub fn set_or_clear_min_healthy_threshold<T>(self, v: Option<T>) -> Self
where T: Into<u32>,

Sets or clears the value of min_healthy_threshold.

§Example
let x = HealthAggregationPolicy::new().set_or_clear_min_healthy_threshold(Some(42_u32));
let x = HealthAggregationPolicy::new().set_or_clear_min_healthy_threshold(None::<u32>);
Source

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

Sets the value of name.

§Example
let x = HealthAggregationPolicy::new().set_name("example");
Source

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 = HealthAggregationPolicy::new().set_or_clear_name(Some("example"));
let x = HealthAggregationPolicy::new().set_or_clear_name(None::<String>);
Source

pub fn set_policy_type<T>(self, v: T) -> Self
where T: Into<PolicyType>,

Sets the value of policy_type.

§Example
use google_cloud_compute_v1::model::health_aggregation_policy::PolicyType;
let x0 = HealthAggregationPolicy::new().set_policy_type(PolicyType::DnsPublicIpPolicy);
Source

pub fn set_or_clear_policy_type<T>(self, v: Option<T>) -> Self
where T: Into<PolicyType>,

Sets or clears the value of policy_type.

§Example
use google_cloud_compute_v1::model::health_aggregation_policy::PolicyType;
let x0 = HealthAggregationPolicy::new().set_or_clear_policy_type(Some(PolicyType::DnsPublicIpPolicy));
let x_none = HealthAggregationPolicy::new().set_or_clear_policy_type(None::<PolicyType>);
Source

pub fn set_region<T>(self, v: T) -> Self
where T: Into<String>,

Sets the value of region.

§Example
let x = HealthAggregationPolicy::new().set_region("example");
Source

pub fn set_or_clear_region<T>(self, v: Option<T>) -> Self
where T: Into<String>,

Sets or clears the value of region.

§Example
let x = HealthAggregationPolicy::new().set_or_clear_region(Some("example"));
let x = HealthAggregationPolicy::new().set_or_clear_region(None::<String>);

Sets the value of self_link.

§Example
let x = HealthAggregationPolicy::new().set_self_link("example");

Sets or clears the value of self_link.

§Example
let x = HealthAggregationPolicy::new().set_or_clear_self_link(Some("example"));
let x = HealthAggregationPolicy::new().set_or_clear_self_link(None::<String>);

Sets the value of self_link_with_id.

§Example
let x = HealthAggregationPolicy::new().set_self_link_with_id("example");

Sets or clears the value of self_link_with_id.

§Example
let x = HealthAggregationPolicy::new().set_or_clear_self_link_with_id(Some("example"));
let x = HealthAggregationPolicy::new().set_or_clear_self_link_with_id(None::<String>);

Trait Implementations§

Source§

impl Clone for HealthAggregationPolicy

Source§

fn clone(&self) -> HealthAggregationPolicy

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for HealthAggregationPolicy

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for HealthAggregationPolicy

Source§

fn default() -> HealthAggregationPolicy

Returns the “default value” for a type. Read more
Source§

impl Message for HealthAggregationPolicy

Source§

fn typename() -> &'static str

The typename of this message.
Source§

impl PartialEq for HealthAggregationPolicy

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl StructuralPartialEq for HealthAggregationPolicy

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,