com.google.api.services.monitoring.v3.model

Class PrometheusQueryLanguageCondition

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.monitoring.v3.model.PrometheusQueryLanguageCondition

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class PrometheusQueryLanguageCondition
extends com.google.api.client.json.GenericJson

A condition type that allows alerting policies to be defined using Prometheus Query Language (PromQL) (https://prometheus.io/docs/prometheus/latest/querying/basics/).The PrometheusQueryLanguageCondition message contains information from a Prometheus alerting rule and its associated rule group.A Prometheus alerting rule is described here (https://prometheus.io/docs/prometheus/latest/configuration/alerting_rules/). The semantics of a Prometheus alerting rule is described here (https://prometheus.io/docs/prometheus/latest/configuration/recording_rules/#rule).A Prometheus rule group is described here (https://prometheus.io/docs/prometheus/latest/configuration/recording_rules/). The semantics of a Prometheus rule group is described here (https://prometheus.io/docs/prometheus/latest/configuration/recording_rules/#rule_group).Because Cloud Alerting has no representation of a Prometheus rule group resource, we must embed the information of the parent rule group inside each of the conditions that refer to it. We must also update the contents of all Prometheus alerts in case the information of their rule group changes.The PrometheusQueryLanguageCondition protocol buffer combines the information of the corresponding rule group and alerting rule. The structure of the PrometheusQueryLanguageCondition protocol buffer does NOT mimic the structure of the Prometheus rule group and alerting rule YAML declarations. The PrometheusQueryLanguageCondition protocol buffer may change in the future to support future rule group and/or alerting rule features. There are no new such features at the present time (2023-06-26).

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Cloud Monitoring API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
PrometheusQueryLanguageCondition()

Method Summary

Modifier and Type	Method and Description
PrometheusQueryLanguageCondition	clone()
String	getAlertRule() Optional.
Boolean	getDisableMetricValidation() Optional.
String	getDuration() Optional.
String	getEvaluationInterval() Optional.
Map<String,String>	getLabels() Optional.
String	getQuery() Required.
String	getRuleGroup() Optional.
PrometheusQueryLanguageCondition	set(String fieldName, Object value)
PrometheusQueryLanguageCondition	setAlertRule(String alertRule) Optional.
PrometheusQueryLanguageCondition	setDisableMetricValidation(Boolean disableMetricValidation) Optional.
PrometheusQueryLanguageCondition	setDuration(String duration) Optional.
PrometheusQueryLanguageCondition	setEvaluationInterval(String evaluationInterval) Optional.
PrometheusQueryLanguageCondition	setLabels(Map<String,String> labels) Optional.
PrometheusQueryLanguageCondition	setQuery(String query) Required.
PrometheusQueryLanguageCondition	setRuleGroup(String ruleGroup) Optional.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

PrometheusQueryLanguageCondition

public PrometheusQueryLanguageCondition()

Method Detail

getAlertRule

public String getAlertRule()

Optional. 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 (https://prometheus.io/docs/concepts/data_model/#metric-names-and- labels). This field may not exceed 2048 Unicode characters in length.

Returns:

value or null for none

setAlertRule

public PrometheusQueryLanguageCondition setAlertRule(String alertRule)

Optional. 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 (https://prometheus.io/docs/concepts/data_model/#metric-names-and- labels). This field may not exceed 2048 Unicode characters in length.

Parameters:

alertRule - alertRule or null for none

getDisableMetricValidation

public Boolean getDisableMetricValidation()

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

Returns:

value or null for none

setDisableMetricValidation

public PrometheusQueryLanguageCondition setDisableMetricValidation(Boolean disableMetricValidation)

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

Parameters:

disableMetricValidation - disableMetricValidation or null for none

getDuration

public String getDuration()

Optional. Alerts are considered firing once their PromQL expression was evaluated to be "true" for this long. Alerts whose PromQL expression was not evaluated to be "true" for long enough are considered pending. Must be a non-negative duration or missing. This field is optional. Its default value is zero.

Returns:

value or null for none

setDuration

public PrometheusQueryLanguageCondition setDuration(String duration)

Optional. Alerts are considered firing once their PromQL expression was evaluated to be "true" for this long. Alerts whose PromQL expression was not evaluated to be "true" for long enough are considered pending. Must be a non-negative duration or missing. This field is optional. Its default value is zero.

Parameters:

duration - duration or null for none

getEvaluationInterval

public String getEvaluationInterval()

Optional. How often this rule should be evaluated. Must be a positive multiple of 30 seconds or missing. This field is optional. Its 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.

Returns:

value or null for none

setEvaluationInterval

public PrometheusQueryLanguageCondition setEvaluationInterval(String evaluationInterval)

Optional. How often this rule should be evaluated. Must be a positive multiple of 30 seconds or missing. This field is optional. Its 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.

Parameters:

evaluationInterval - evaluationInterval or null for none

getLabels

public Map<String,String> getLabels()

Optional. Labels to add to or overwrite in the PromQL query result. Label names must be valid (https://prometheus.io/docs/concepts/data_model/#metric-names-and-labels). Label values can be templatized by using variables (https://cloud.google.com/monitoring/alerts/doc-variables#doc- vars). The only available variable names are the names of the labels in the PromQL result, including "__name__" and "value". "labels" may be empty.

Returns:

value or null for none

setLabels

public PrometheusQueryLanguageCondition setLabels(Map<String,String> labels)

Optional. Labels to add to or overwrite in the PromQL query result. Label names must be valid (https://prometheus.io/docs/concepts/data_model/#metric-names-and-labels). Label values can be templatized by using variables (https://cloud.google.com/monitoring/alerts/doc-variables#doc- vars). The only available variable names are the names of the labels in the PromQL result, including "__name__" and "value". "labels" may be empty.

Parameters:

labels - labels or null for none

getQuery

public String getQuery()

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

Returns:

value or null for none

setQuery

public PrometheusQueryLanguageCondition setQuery(String query)

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

Parameters:

query - query or null for none

getRuleGroup

public String getRuleGroup()

Optional. 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. If this field is not empty, then it must contain a valid UTF-8 string. This field may not exceed 2048 Unicode characters in length.

Returns:

value or null for none

setRuleGroup

public PrometheusQueryLanguageCondition setRuleGroup(String ruleGroup)

Optional. 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. If this field is not empty, then it must contain a valid UTF-8 string. This field may not exceed 2048 Unicode characters in length.

Parameters:

ruleGroup - ruleGroup or null for none

set

public PrometheusQueryLanguageCondition set(String fieldName,
                                            Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public PrometheusQueryLanguageCondition clone()

Overrides:

clone in class com.google.api.client.json.GenericJson