Skip to main content

HealthCheckService

Struct HealthCheckService 

Source
#[non_exhaustive]
pub struct HealthCheckService { pub creation_timestamp: Option<String>, pub description: Option<String>, pub fingerprint: Option<Bytes>, pub health_checks: Vec<String>, pub health_status_aggregation_policy: Option<HealthStatusAggregationPolicy>, pub id: Option<u64>, pub kind: Option<String>, pub name: Option<String>, pub network_endpoint_groups: Vec<String>, pub notification_endpoints: Vec<String>, pub region: Option<String>, pub self_link: Option<String>, /* private fields */ }
Available on crate feature region-health-check-services only.
Expand description

Represents a Health-Check as a Service resource.

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 HealthCheckService. An up-to-date fingerprint must be provided in order to patch/update the HealthCheckService; Otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the HealthCheckService.

§health_checks: Vec<String>

A list of URLs to the HealthCheck resources. Must have at least one HealthCheck, and not more than 10 for regionalHealthCheckService, and not more than 1 for globalHealthCheckService.HealthCheck resources must haveportSpecification=USE_SERVING_PORT orportSpecification=USE_FIXED_PORT. For regional HealthCheckService, theHealthCheck must be regional and in the same region. For global HealthCheckService,HealthCheck must be global. Mix of regional and globalHealthChecks is not supported. Multiple regionalHealthChecks must belong to the same region. RegionalHealthChecks must belong to the same region as zones ofNetworkEndpointGroups. For globalHealthCheckService using globalINTERNET_IP_PORT NetworkEndpointGroups, the global HealthChecks must specify sourceRegions, and HealthChecks that specify sourceRegions can only be used with global INTERNET_IP_PORTNetworkEndpointGroups.

§health_status_aggregation_policy: Option<HealthStatusAggregationPolicy>

Optional. Policy for how the results from multiple health checks for the same endpoint are aggregated. Defaults to NO_AGGREGATION if unspecified.

  • NO_AGGREGATION. An EndpointHealth message is returned for each pair in the health check service.
  • AND. If any health check of an endpoint reportsUNHEALTHY, then UNHEALTHY is theHealthState of the endpoint. If all health checks reportHEALTHY, the HealthState of the endpoint isHEALTHY.

. This is only allowed with regional HealthCheckService.

§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#healthCheckServicefor health check services.

§name: Option<String>

Name of the resource. The name must be 1-63 characters long, and comply with RFC1035. 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.

§network_endpoint_groups: Vec<String>

A list of URLs to the NetworkEndpointGroup resources. Must not have more than 100. For regionalHealthCheckService, NEGs must be in zones in the region of the HealthCheckService. For globalHealthCheckServices, the NetworkEndpointGroups must be global INTERNET_IP_PORT.

§notification_endpoints: Vec<String>

A list of URLs to the NotificationEndpoint resources. Must not have more than 10. A list of endpoints for receiving notifications of change in health status. For regionalHealthCheckService,NotificationEndpoint must be regional and in the same region. For global HealthCheckService,NotificationEndpoint must be global.

§region: Option<String>

Output only. [Output Only] URL of the region where the health check service resides. This field is not applicable to global health check services. 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.

Implementations§

Source§

impl HealthCheckService

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 = HealthCheckService::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 = HealthCheckService::new().set_or_clear_creation_timestamp(Some("example"));
let x = HealthCheckService::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 = HealthCheckService::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 = HealthCheckService::new().set_or_clear_description(Some("example"));
let x = HealthCheckService::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 = HealthCheckService::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 = HealthCheckService::new().set_or_clear_fingerprint(Some(bytes::Bytes::from_static(b"example")));
let x = HealthCheckService::new().set_or_clear_fingerprint(None::<bytes::Bytes>);
Source

pub fn set_health_checks<T, V>(self, v: T) -> Self
where T: IntoIterator<Item = V>, V: Into<String>,

Sets the value of health_checks.

§Example
let x = HealthCheckService::new().set_health_checks(["a", "b", "c"]);
Source

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

Sets the value of health_status_aggregation_policy.

§Example
use google_cloud_compute_v1::model::health_check_service::HealthStatusAggregationPolicy;
let x0 = HealthCheckService::new().set_health_status_aggregation_policy(HealthStatusAggregationPolicy::NoAggregation);
Source

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

Sets or clears the value of health_status_aggregation_policy.

§Example
use google_cloud_compute_v1::model::health_check_service::HealthStatusAggregationPolicy;
let x0 = HealthCheckService::new().set_or_clear_health_status_aggregation_policy(Some(HealthStatusAggregationPolicy::NoAggregation));
let x_none = HealthCheckService::new().set_or_clear_health_status_aggregation_policy(None::<HealthStatusAggregationPolicy>);
Source

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

Sets the value of id.

§Example
let x = HealthCheckService::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 = HealthCheckService::new().set_or_clear_id(Some(42_u32));
let x = HealthCheckService::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 = HealthCheckService::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 = HealthCheckService::new().set_or_clear_kind(Some("example"));
let x = HealthCheckService::new().set_or_clear_kind(None::<String>);
Source

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

Sets the value of name.

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

pub fn set_network_endpoint_groups<T, V>(self, v: T) -> Self
where T: IntoIterator<Item = V>, V: Into<String>,

Sets the value of network_endpoint_groups.

§Example
let x = HealthCheckService::new().set_network_endpoint_groups(["a", "b", "c"]);
Source

pub fn set_notification_endpoints<T, V>(self, v: T) -> Self
where T: IntoIterator<Item = V>, V: Into<String>,

Sets the value of notification_endpoints.

§Example
let x = HealthCheckService::new().set_notification_endpoints(["a", "b", "c"]);
Source

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

Sets the value of region.

§Example
let x = HealthCheckService::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 = HealthCheckService::new().set_or_clear_region(Some("example"));
let x = HealthCheckService::new().set_or_clear_region(None::<String>);

Sets the value of self_link.

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

Sets or clears the value of self_link.

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

Trait Implementations§

Source§

impl Clone for HealthCheckService

Source§

fn clone(&self) -> HealthCheckService

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 HealthCheckService

Source§

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

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

impl Default for HealthCheckService

Source§

fn default() -> HealthCheckService

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

impl Message for HealthCheckService

Source§

fn typename() -> &'static str

The typename of this message.
Source§

impl PartialEq for HealthCheckService

Source§

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

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> 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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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>,