Struct UptimeCheckConfig

#[non_exhaustive]
pub struct UptimeCheckConfig {
    pub name: String,
    pub display_name: String,
    pub period: Option<Duration>,
    pub timeout: Option<Duration>,
    pub content_matchers: Vec<ContentMatcher>,
    pub checker_type: CheckerType,
    pub selected_regions: Vec<UptimeCheckRegion>,
    pub is_internal: bool,
    pub internal_checkers: Vec<InternalChecker>,
    pub user_labels: HashMap<String, String>,
    pub resource: Option<Resource>,
    pub check_request_type: Option<CheckRequestType>,
}

This message configures which resources and services to monitor for availability.

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.

name: String

Identifier. A unique resource name for this Uptime check configuration. The format is:

 projects/[PROJECT_ID_OR_NUMBER]/uptimeCheckConfigs/[UPTIME_CHECK_ID]

[PROJECT_ID_OR_NUMBER] is the Workspace host project associated with the Uptime check.

This field should be omitted when creating the Uptime check configuration; on create, the resource name is assigned by the server and included in the response.

display_name: String

A human-friendly name for the Uptime check configuration. The display name should be unique within a Cloud Monitoring Workspace in order to make it easier to identify; however, uniqueness is not enforced. Required.

period: Option<Duration>

How often, in seconds, the Uptime check is performed. Currently, the only supported values are 60s (1 minute), 300s (5 minutes), 600s (10 minutes), and 900s (15 minutes). Optional, defaults to 60s.

timeout: Option<Duration>

The maximum amount of time to wait for the request to complete (must be between 1 and 60 seconds). Required.

content_matchers: Vec<ContentMatcher>

The content that is expected to appear in the data returned by the target server against which the check is run. Currently, only the first entry in the content_matchers list is supported, and additional entries will be ignored. This field is optional and should only be specified if a content match is required as part of the/ Uptime check.

checker_type: CheckerType

The type of checkers to use to execute the Uptime check.

selected_regions: Vec<UptimeCheckRegion>

The list of regions from which the check will be run. Some regions contain one location, and others contain more than one. If this field is specified, enough regions must be provided to include a minimum of 3 locations. Not specifying this field will result in Uptime checks running from all available regions.

is_internal: bool

If this is true, then checks are made only from the ‘internal_checkers’. If it is false, then checks are made only from the ‘selected_regions’. It is an error to provide ‘selected_regions’ when is_internal is true, or to provide ‘internal_checkers’ when is_internal is false.

internal_checkers: Vec<InternalChecker>

The internal checkers that this check will egress from. If is_internal is true and this list is empty, the check will egress from all the InternalCheckers configured for the project that owns this UptimeCheckConfig.

user_labels: HashMap<String, String>

User-supplied key/value data to be used for organizing and identifying the UptimeCheckConfig objects.

The field can contain up to 64 entries. Each key and value is limited to 63 Unicode characters or 128 bytes, whichever is smaller. Labels and values can contain only lowercase letters, numerals, underscores, and dashes. Keys must begin with a letter.

resource: Option<Resource>

The resource the check is checking. Required.

check_request_type: Option<CheckRequestType>

The type of Uptime check request.

Implementations

impl UptimeCheckConfig

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

Sets the value of name.

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

Sets the value of display_name.

pub fn set_period<T: Into<Option<Duration>>>(self, v: T) -> Self

Sets the value of period.

pub fn set_timeout<T: Into<Option<Duration>>>(self, v: T) -> Self

Sets the value of timeout.

pub fn set_checker_type<T: Into<CheckerType>>(self, v: T) -> Self

Sets the value of checker_type.

pub fn set_is_internal<T: Into<bool>>(self, v: T) -> Self

Sets the value of is_internal.

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

where T: IntoIterator<Item = V>, V: Into<ContentMatcher>,

Sets the value of content_matchers.

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

where T: IntoIterator<Item = V>, V: Into<UptimeCheckRegion>,

Sets the value of selected_regions.

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

where T: IntoIterator<Item = V>, V: Into<InternalChecker>,

Sets the value of internal_checkers.

pub fn set_user_labels<T, K, V>(self, v: T) -> Self

where T: IntoIterator<Item = (K, V)>, K: Into<String>, V: Into<String>,

Sets the value of user_labels.

pub fn set_resource<T: Into<Option<Resource>>>(self, v: T) -> Self

Sets the value of resource.

pub fn get_monitored_resource(&self) -> Option<&Box<MonitoredResource>>

The value of resource if it holds a MonitoredResource, None if the field is not set or holds a different branch.

pub fn get_resource_group(&self) -> Option<&Box<ResourceGroup>>

The value of resource if it holds a ResourceGroup, None if the field is not set or holds a different branch.

pub fn get_synthetic_monitor(&self) -> Option<&Box<SyntheticMonitorTarget>>

The value of resource if it holds a SyntheticMonitor, None if the field is not set or holds a different branch.

pub fn set_monitored_resource<T: Into<Box<MonitoredResource>>>( self, v: T, ) -> Self

Sets the value of resource to hold a MonitoredResource.

Note that all the setters affecting resource are mutually exclusive.

pub fn set_resource_group<T: Into<Box<ResourceGroup>>>(self, v: T) -> Self

Sets the value of resource to hold a ResourceGroup.

Note that all the setters affecting resource are mutually exclusive.

pub fn set_synthetic_monitor<T: Into<Box<SyntheticMonitorTarget>>>( self, v: T, ) -> Self

Sets the value of resource to hold a SyntheticMonitor.

Note that all the setters affecting resource are mutually exclusive.

pub fn set_check_request_type<T: Into<Option<CheckRequestType>>>( self, v: T, ) -> Self

Sets the value of check_request_type.

pub fn get_http_check(&self) -> Option<&Box<HttpCheck>>

The value of check_request_type if it holds a HttpCheck, None if the field is not set or holds a different branch.

pub fn get_tcp_check(&self) -> Option<&Box<TcpCheck>>

The value of check_request_type if it holds a TcpCheck, None if the field is not set or holds a different branch.

pub fn set_http_check<T: Into<Box<HttpCheck>>>(self, v: T) -> Self

Sets the value of check_request_type to hold a HttpCheck.

Note that all the setters affecting check_request_type are mutually exclusive.

pub fn set_tcp_check<T: Into<Box<TcpCheck>>>(self, v: T) -> Self

Sets the value of check_request_type to hold a TcpCheck.

Note that all the setters affecting check_request_type are mutually exclusive.

Trait Implementations

impl Clone for UptimeCheckConfig

fn clone(&self) -> UptimeCheckConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UptimeCheckConfig

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

Formats the value using the given formatter.

impl Default for UptimeCheckConfig

fn default() -> UptimeCheckConfig

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for UptimeCheckConfig

where UptimeCheckConfig: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Message for UptimeCheckConfig

fn typename() -> &'static str

The typename of this message.

impl PartialEq for UptimeCheckConfig

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for UptimeCheckConfig