AlertPolicyConditionConditionPrometheusQueryLanguage class

Constructors

AlertPolicyConditionConditionPrometheusQueryLanguage({Input<String?>? alertRule, Input<bool?>? disableMetricValidation, Input<String?>? duration, Input<String?>? evaluationInterval, Input<Map<String, String>?>? labels, required Input<String> query, Input<String?>? ruleGroup})
Creates a new AlertPolicyConditionConditionPrometheusQueryLanguage. alertRule The alerting rule name of this alert in the corresponding Prometheus disableMetricValidation Whether to disable metric existence validation for this condition. duration Alerts are considered firing once their PromQL expression evaluated evaluationInterval How often this rule should be evaluated. Must be a positive multiple labels Labels to add to or overwrite in the PromQL query result. Label names query The PromQL expression to evaluate. Every evaluation cycle this ruleGroup The rule group name of this alert in the corresponding Prometheus
const
AlertPolicyConditionConditionPrometheusQueryLanguage.fromMap(Map<String, dynamic> map)
factory

Properties

alertRule → Input<String?>?
The alerting rule name of this alert in the corresponding Prometheus configuration file. Some external tools may require this field to be populated correctly in order to refer to the original Prometheus configuration file. The rule group name and the alert name are necessary to update the relevant AlertPolicies in case the definition of the rule group changes in the future. This field is optional. If this field is not empty, then it must be a valid Prometheus label name.
final
disableMetricValidation → Input<bool?>?
Whether to disable metric existence validation for this condition. This allows alerting policies to be defined on metrics that do not yet exist, improving advanced customer workflows such as configuring alerting policies using Terraform. Users with the monitoring.alertPolicyViewer role are able to see the name of the non-existent metric in the alerting policy condition.
final
duration → Input<String?>?
Alerts are considered firing once their PromQL expression evaluated to be "true" for this long. Alerts whose PromQL expression was not evaluated to be "true" for long enough are considered pending. The default value is zero. Must be zero or positive.
final
evaluationInterval → Input<String?>?
How often this rule should be evaluated. Must be a positive multiple of 30 seconds or missing. The default value is 30 seconds. If this PrometheusQueryLanguageCondition was generated from a Prometheus alerting rule, then this value should be taken from the enclosing rule group.
final
hashCode → int
The hash code for this object.
no setterinherited
labels → Input<Map<String, String>?>?
Labels to add to or overwrite in the PromQL query result. Label names must be valid. Label values can be templatized by using variables. The only available variable names are the names of the labels in the PromQL result, although label names beginning with __ (two "_") are reserved for internal use. "labels" may be empty. This field is intended to be used for organizing and identifying the AlertPolicy.
final
query → Input<String>
The PromQL expression to evaluate. Every evaluation cycle this expression is evaluated at the current time, and all resultant time series become pending/firing alerts. This field must not be empty.
final
ruleGroup → Input<String?>?
The rule group name of this alert in the corresponding Prometheus configuration file. Some external tools may require this field to be populated correctly in order to refer to the original Prometheus configuration file. The rule group name and the alert name are necessary to update the relevant AlertPolicies in case the definition of the rule group changes in the future. This field is optional.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited