Struct google_api_proto::google::monitoring::v3::UptimeCheckConfig

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: i32,
    pub selected_regions: Vec<i32>,
    pub is_internal: bool,
    pub internal_checkers: Vec<InternalChecker>,
    pub user_labels: BTreeMap<String, String>,
    pub resource: Option<Resource>,
    pub check_request_type: Option<CheckRequestType>,
}

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

Fields

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: i32

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

selected_regions: Vec<i32>

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

👎Deprecated

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>

👎Deprecated

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: BTreeMap<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 selected_regions( &self, ) -> FilterMap<Cloned<Iter<'_, i32>>, fn(_: i32) -> Option<UptimeCheckRegion>>

Returns an iterator which yields the valid enum values contained in selected_regions.

pub fn push_selected_regions(&mut self, value: UptimeCheckRegion)

Appends the provided enum value to selected_regions.

pub fn checker_type(&self) -> CheckerType

Returns the enum value of checker_type, or the default if the field is set to an invalid enum value.

pub fn set_checker_type(&mut self, value: CheckerType)

Sets checker_type to the provided enum value.

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() -> Self

Returns the “default value” for a type.

impl Message for UptimeCheckConfig

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for UptimeCheckConfig

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for UptimeCheckConfig