Struct google_monitoring3::AlertPolicy

pub struct AlertPolicy {
    pub combiner: Option<String>,
    pub display_name: Option<String>,
    pub name: Option<String>,
    pub creation_record: Option<MutationRecord>,
    pub documentation: Option<Documentation>,
    pub enabled: Option<bool>,
    pub validity: Option<Status>,
    pub mutation_record: Option<MutationRecord>,
    pub user_labels: Option<HashMap<String, String>>,
    pub notification_channels: Option<Vec<String>>,
    pub conditions: Option<Vec<Condition>>,
}

A description of the conditions under which some aspect of your system is considered to be "unhealthy" and the ways to notify people or services about this state. For an overview of alert policies, see Introduction to Alerting (https://cloud.google.com/monitoring/alerts/).

Activities

This type is used in activities, which are methods you may call on this type or where this type is involved in. The list links the activity name, along with information about where it is used (one of request and response).

• alert policies get projects (response)
• alert policies patch projects (request|response)
• alert policies create projects (request|response)

Fields

combiner: Option<String>

How to combine the results of multiple conditions to determine if an incident should be opened. If condition_time_series_query_language is present, this must be COMBINE_UNSPECIFIED.

display_name: Option<String>

A short name or phrase used to identify the policy in dashboards, notifications, and incidents. To avoid confusion, don't use the same display name for multiple policies in the same project. The name is limited to 512 Unicode characters.

name: Option<String>

Required if the policy exists. The resource name for this policy. The format is: projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[ALERT_POLICY_ID] [ALERT_POLICY_ID] is assigned by Stackdriver Monitoring when the policy is created. When calling the alertPolicies.create method, do not include the name field in the alerting policy passed as part of the request.

creation_record: Option<MutationRecord>

A read-only record of the creation of the alerting policy. If provided in a call to create or update, this field will be ignored.

documentation: Option<Documentation>

Documentation that is included with notifications and incidents related to this policy. Best practice is for the documentation to include information to help responders understand, mitigate, escalate, and correct the underlying problems detected by the alerting policy. Notification channels that have limited capacity might not show this documentation.

enabled: Option<bool>

Whether or not the policy is enabled. On write, the default interpretation if unset is that the policy is enabled. On read, clients should not make any assumption about the state if it has not been populated. The field should always be populated on List and Get operations, unless a field projection has been specified that strips it out.

validity: Option<Status>

Read-only description of how the alert policy is invalid. OK if the alert policy is valid. If not OK, the alert policy will not generate incidents.

mutation_record: Option<MutationRecord>

A read-only record of the most recent change to the alerting policy. If provided in a call to create or update, this field will be ignored.

user_labels: Option<HashMap<String, String>>

User-supplied key/value data to be used for organizing and identifying the AlertPolicy 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.

notification_channels: Option<Vec<String>>

Identifies the notification channels to which notifications should be sent when incidents are opened or closed or when new violations occur on an already opened incident. Each element of this array corresponds to the name field in each of the NotificationChannel objects that are returned from the ListNotificationChannels method. The format of the entries in this field is: projects/[PROJECT_ID_OR_NUMBER]/notificationChannels/[CHANNEL_ID]

conditions: Option<Vec<Condition>>

A list of conditions for the policy. The conditions are combined by AND or OR according to the combiner field. If the combined conditions evaluate to true, then an incident is created. A policy can have from one to six conditions. If condition_time_series_query_language is present, it must be the only condition.

Trait Implementations

impl Clone for AlertPolicy

fn clone(&self) -> AlertPolicy

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AlertPolicy

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

Formats the value using the given formatter.

impl Default for AlertPolicy

fn default() -> AlertPolicy

Returns the "default value" for a type.

impl<'de> Deserialize<'de> for AlertPolicy

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl RequestValue for AlertPolicy

impl ResponseResult for AlertPolicy

impl Serialize for AlertPolicy

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

Serialize this value into the given Serde serializer.