Struct AlertPolicy

#[non_exhaustive]
pub struct AlertPolicy {

    pub name: String,
    pub display_name: String,
    pub documentation: Option<Documentation>,
    pub user_labels: HashMap<String, String>,
    pub conditions: Vec<Condition>,
    pub combiner: ConditionCombinerType,
    pub enabled: Option<BoolValue>,
    pub validity: Option<Status>,
    pub notification_channels: Vec<String>,
    pub creation_record: Option<MutationRecord>,
    pub mutation_record: Option<MutationRecord>,
    pub alert_strategy: Option<AlertStrategy>,
    pub severity: Severity,
}

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 alerting policies, see Introduction to Alerting.

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. 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 Cloud 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.

display_name: 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.

The convention for the display_name of a PrometheusQueryLanguageCondition is “{rule group name}/{alert name}”, where the {rule group name} and {alert name} should be taken from the corresponding Prometheus configuration file. This convention is not enforced. In any case the display_name is not a unique key of the AlertPolicy.

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.

user_labels: 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.

Note that Prometheus {alert name} is a valid Prometheus label names, whereas Prometheus {rule group} is an unrestricted UTF-8 string. This means that they cannot be stored as-is in user labels, because they may contain characters that are not allowed in user-label values.

conditions: 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. If condition_monitoring_query_language is present, it must be the only condition.

combiner: ConditionCombinerType

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.

enabled: Option<BoolValue>

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 alerting policy is invalid. This field is only set when the alerting policy is invalid. An invalid alerting policy will not generate incidents.

notification_channels: 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] [google.monitoring.v3.NotificationChannelService.ListNotificationChannels] method. The format of the entries in this field is:

projects/[PROJECT_ID_OR_NUMBER]/notificationChannels/[CHANNEL_ID]

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.

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.

alert_strategy: Option<AlertStrategy>

Control over how this alerting policy’s notification channels are notified.

severity: Severity

Optional. The severity of an alerting policy indicates how important incidents generated by that policy are. The severity level will be displayed on the Incident detail page and in notifications.

Implementations

impl AlertPolicy

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_documentation<T: Into<Option<Documentation>>>(self, v: T) -> Self

Sets the value of documentation.

pub fn set_combiner<T: Into<ConditionCombinerType>>(self, v: T) -> Self

Sets the value of combiner.

pub fn set_enabled<T: Into<Option<BoolValue>>>(self, v: T) -> Self

Sets the value of enabled.

pub fn set_validity<T: Into<Option<Status>>>(self, v: T) -> Self

Sets the value of validity.

pub fn set_creation_record<T: Into<Option<MutationRecord>>>(self, v: T) -> Self

Sets the value of creation_record.

pub fn set_mutation_record<T: Into<Option<MutationRecord>>>(self, v: T) -> Self

Sets the value of mutation_record.

pub fn set_alert_strategy<T: Into<Option<AlertStrategy>>>(self, v: T) -> Self

Sets the value of alert_strategy.

pub fn set_severity<T: Into<Severity>>(self, v: T) -> Self

Sets the value of severity.

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

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

Sets the value of conditions.

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

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

Sets the value of notification_channels.

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.

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

where AlertPolicy: 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 AlertPolicy

fn typename() -> &'static str

The typename of this message.

impl PartialEq for AlertPolicy

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

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 AlertPolicy