- 3.54.0 (latest)
- 3.53.0
- 3.52.0
- 3.50.0
- 3.49.0
- 3.48.0
- 3.47.0
- 3.46.0
- 3.45.0
- 3.44.0
- 3.43.0
- 3.42.0
- 3.41.0
- 3.40.0
- 3.38.0
- 3.37.0
- 3.36.0
- 3.35.0
- 3.34.0
- 3.33.0
- 3.32.0
- 3.31.0
- 3.30.0
- 3.29.0
- 3.28.0
- 3.25.0
- 3.24.0
- 3.23.0
- 3.22.0
- 3.21.0
- 3.20.0
- 3.19.0
- 3.18.0
- 3.17.0
- 3.16.0
- 3.15.0
- 3.14.0
- 3.13.0
- 3.12.0
- 3.10.0
- 3.9.0
- 3.8.0
- 3.7.0
- 3.6.0
- 3.5.0
- 3.4.6
- 3.3.6
- 3.2.10
public static final class AlertPolicy.Condition.PrometheusQueryLanguageCondition.Builder extends GeneratedMessageV3.Builder<AlertPolicy.Condition.PrometheusQueryLanguageCondition.Builder> implements AlertPolicy.Condition.PrometheusQueryLanguageConditionOrBuilderA condition type that allows alert policies to be defined using Prometheus Query Language (PromQL).
The PrometheusQueryLanguageCondition message contains information from a Prometheus alerting rule and its associated rule group.
A Prometheus alerting rule is described here. The semantics of a Prometheus alerting rule is described here.
A Prometheus rule group is described here. The semantics of a Prometheus rule group is described here.
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).
Protobuf type
google.monitoring.v3.AlertPolicy.Condition.PrometheusQueryLanguageCondition
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > AlertPolicy.Condition.PrometheusQueryLanguageCondition.BuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public AlertPolicy.Condition.PrometheusQueryLanguageCondition.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
value | Object |
| Returns | |
|---|---|
| Type | Description |
AlertPolicy.Condition.PrometheusQueryLanguageCondition.Builder | |
build()
public AlertPolicy.Condition.PrometheusQueryLanguageCondition build()| Returns | |
|---|---|
| Type | Description |
AlertPolicy.Condition.PrometheusQueryLanguageCondition | |
buildPartial()
public AlertPolicy.Condition.PrometheusQueryLanguageCondition buildPartial()| Returns | |
|---|---|
| Type | Description |
AlertPolicy.Condition.PrometheusQueryLanguageCondition | |
clear()
public AlertPolicy.Condition.PrometheusQueryLanguageCondition.Builder clear()| Returns | |
|---|---|
| Type | Description |
AlertPolicy.Condition.PrometheusQueryLanguageCondition.Builder | |
clearAlertRule()
public AlertPolicy.Condition.PrometheusQueryLanguageCondition.Builder clearAlertRule()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. This field may not exceed 2048 Unicode characters in length.
string alert_rule = 6 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
AlertPolicy.Condition.PrometheusQueryLanguageCondition.Builder | This builder for chaining. |
clearDuration()
public AlertPolicy.Condition.PrometheusQueryLanguageCondition.Builder clearDuration()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.
.google.protobuf.Duration duration = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
AlertPolicy.Condition.PrometheusQueryLanguageCondition.Builder | |
clearEvaluationInterval()
public AlertPolicy.Condition.PrometheusQueryLanguageCondition.Builder clearEvaluationInterval()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.
.google.protobuf.Duration evaluation_interval = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
AlertPolicy.Condition.PrometheusQueryLanguageCondition.Builder | |
clearField(Descriptors.FieldDescriptor field)
public AlertPolicy.Condition.PrometheusQueryLanguageCondition.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field | FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
AlertPolicy.Condition.PrometheusQueryLanguageCondition.Builder | |
clearLabels()
public AlertPolicy.Condition.PrometheusQueryLanguageCondition.Builder clearLabels()| Returns | |
|---|---|
| Type | Description |
AlertPolicy.Condition.PrometheusQueryLanguageCondition.Builder | |
clearOneof(Descriptors.OneofDescriptor oneof)
public AlertPolicy.Condition.PrometheusQueryLanguageCondition.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof | OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
AlertPolicy.Condition.PrometheusQueryLanguageCondition.Builder | |
clearQuery()
public AlertPolicy.Condition.PrometheusQueryLanguageCondition.Builder clearQuery()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.
string query = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
AlertPolicy.Condition.PrometheusQueryLanguageCondition.Builder | This builder for chaining. |
clearRuleGroup()
public AlertPolicy.Condition.PrometheusQueryLanguageCondition.Builder clearRuleGroup()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.
string rule_group = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
AlertPolicy.Condition.PrometheusQueryLanguageCondition.Builder | This builder for chaining. |
clone()
public AlertPolicy.Condition.PrometheusQueryLanguageCondition.Builder clone()| Returns | |
|---|---|
| Type | Description |
AlertPolicy.Condition.PrometheusQueryLanguageCondition.Builder | |
containsLabels(String key)
public boolean containsLabels(String key)Optional. 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, including "name" and "value". "labels" may be empty.
map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
key | String |
| Returns | |
|---|---|
| Type | Description |
boolean | |
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. This field may not exceed 2048 Unicode characters in length.
string alert_rule = 6 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String | The alertRule. |
getAlertRuleBytes()
public ByteString getAlertRuleBytes()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. This field may not exceed 2048 Unicode characters in length.
string alert_rule = 6 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for alertRule. |
getDefaultInstanceForType()
public AlertPolicy.Condition.PrometheusQueryLanguageCondition getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
AlertPolicy.Condition.PrometheusQueryLanguageCondition | |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
getDuration()
public Duration 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.
.google.protobuf.Duration duration = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Duration | The duration. |
getDurationBuilder()
public Duration.Builder getDurationBuilder()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.
.google.protobuf.Duration duration = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Builder | |
getDurationOrBuilder()
public DurationOrBuilder getDurationOrBuilder()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.
.google.protobuf.Duration duration = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
DurationOrBuilder | |
getEvaluationInterval()
public Duration 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.
.google.protobuf.Duration evaluation_interval = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Duration | The evaluationInterval. |
getEvaluationIntervalBuilder()
public Duration.Builder getEvaluationIntervalBuilder()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.
.google.protobuf.Duration evaluation_interval = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Builder | |
getEvaluationIntervalOrBuilder()
public DurationOrBuilder getEvaluationIntervalOrBuilder()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.
.google.protobuf.Duration evaluation_interval = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
DurationOrBuilder | |
getLabels() (deprecated)
public Map<String,String> getLabels()Use #getLabelsMap() instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> | |
getLabelsCount()
public int getLabelsCount()Optional. 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, including "name" and "value". "labels" may be empty.
map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int | |
getLabelsMap()
public Map<String,String> getLabelsMap()Optional. 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, including "name" and "value". "labels" may be empty.
map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Map<String,String> | |
getLabelsOrDefault(String key, String defaultValue)
public String getLabelsOrDefault(String key, String defaultValue)Optional. 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, including "name" and "value". "labels" may be empty.
map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];
| Parameters | |
|---|---|
| Name | Description |
key | String |
defaultValue | String |
| Returns | |
|---|---|
| Type | Description |
String | |
getLabelsOrThrow(String key)
public String getLabelsOrThrow(String key)Optional. 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, including "name" and "value". "labels" may be empty.
map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
key | String |
| Returns | |
|---|---|
| Type | Description |
String | |
getMutableLabels() (deprecated)
public Map<String,String> getMutableLabels()Use alternate mutation accessors instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> | |
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.
string query = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
String | The query. |
getQueryBytes()
public ByteString getQueryBytes()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.
string query = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for query. |
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.
string rule_group = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String | The ruleGroup. |
getRuleGroupBytes()
public ByteString getRuleGroupBytes()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.
string rule_group = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for ruleGroup. |
hasDuration()
public boolean hasDuration()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.
.google.protobuf.Duration duration = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the duration field is set. |
hasEvaluationInterval()
public boolean hasEvaluationInterval()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.
.google.protobuf.Duration evaluation_interval = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the evaluationInterval field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable | |
internalGetMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)| Parameter | |
|---|---|
| Name | Description |
number | int |
| Returns | |
|---|---|
| Type | Description |
com.google.protobuf.MapFieldReflectionAccessor | |
internalGetMutableMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)| Parameter | |
|---|---|
| Name | Description |
number | int |
| Returns | |
|---|---|
| Type | Description |
com.google.protobuf.MapFieldReflectionAccessor | |
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean | |
mergeDuration(Duration value)
public AlertPolicy.Condition.PrometheusQueryLanguageCondition.Builder mergeDuration(Duration value)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.
.google.protobuf.Duration duration = 2 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value | Duration |
| Returns | |
|---|---|
| Type | Description |
AlertPolicy.Condition.PrometheusQueryLanguageCondition.Builder | |
mergeEvaluationInterval(Duration value)
public AlertPolicy.Condition.PrometheusQueryLanguageCondition.Builder mergeEvaluationInterval(Duration value)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.
.google.protobuf.Duration evaluation_interval = 3 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value | Duration |
| Returns | |
|---|---|
| Type | Description |
AlertPolicy.Condition.PrometheusQueryLanguageCondition.Builder | |
mergeFrom(AlertPolicy.Condition.PrometheusQueryLanguageCondition other)
public AlertPolicy.Condition.PrometheusQueryLanguageCondition.Builder mergeFrom(AlertPolicy.Condition.PrometheusQueryLanguageCondition other)| Parameter | |
|---|---|
| Name | Description |
other | AlertPolicy.Condition.PrometheusQueryLanguageCondition |
| Returns | |
|---|---|
| Type | Description |
AlertPolicy.Condition.PrometheusQueryLanguageCondition.Builder | |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public AlertPolicy.Condition.PrometheusQueryLanguageCondition.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
AlertPolicy.Condition.PrometheusQueryLanguageCondition.Builder | |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |
mergeFrom(Message other)
public AlertPolicy.Condition.PrometheusQueryLanguageCondition.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other | Message |
| Returns | |
|---|---|
| Type | Description |
AlertPolicy.Condition.PrometheusQueryLanguageCondition.Builder | |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final AlertPolicy.Condition.PrometheusQueryLanguageCondition.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields | UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
AlertPolicy.Condition.PrometheusQueryLanguageCondition.Builder | |
putAllLabels(Map<String,String> values)
public AlertPolicy.Condition.PrometheusQueryLanguageCondition.Builder putAllLabels(Map<String,String> values)Optional. 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, including "name" and "value". "labels" may be empty.
map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
values | Map<String,String> |
| Returns | |
|---|---|
| Type | Description |
AlertPolicy.Condition.PrometheusQueryLanguageCondition.Builder | |
putLabels(String key, String value)
public AlertPolicy.Condition.PrometheusQueryLanguageCondition.Builder putLabels(String key, String value)Optional. 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, including "name" and "value". "labels" may be empty.
map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];
| Parameters | |
|---|---|
| Name | Description |
key | String |
value | String |
| Returns | |
|---|---|
| Type | Description |
AlertPolicy.Condition.PrometheusQueryLanguageCondition.Builder | |
removeLabels(String key)
public AlertPolicy.Condition.PrometheusQueryLanguageCondition.Builder removeLabels(String key)Optional. 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, including "name" and "value". "labels" may be empty.
map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
key | String |
| Returns | |
|---|---|
| Type | Description |
AlertPolicy.Condition.PrometheusQueryLanguageCondition.Builder | |
setAlertRule(String value)
public AlertPolicy.Condition.PrometheusQueryLanguageCondition.Builder setAlertRule(String value)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. This field may not exceed 2048 Unicode characters in length.
string alert_rule = 6 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value | StringThe alertRule to set. |
| Returns | |
|---|---|
| Type | Description |
AlertPolicy.Condition.PrometheusQueryLanguageCondition.Builder | This builder for chaining. |
setAlertRuleBytes(ByteString value)
public AlertPolicy.Condition.PrometheusQueryLanguageCondition.Builder setAlertRuleBytes(ByteString value)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. This field may not exceed 2048 Unicode characters in length.
string alert_rule = 6 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for alertRule to set. |
| Returns | |
|---|---|
| Type | Description |
AlertPolicy.Condition.PrometheusQueryLanguageCondition.Builder | This builder for chaining. |
setDuration(Duration value)
public AlertPolicy.Condition.PrometheusQueryLanguageCondition.Builder setDuration(Duration value)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.
.google.protobuf.Duration duration = 2 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value | Duration |
| Returns | |
|---|---|
| Type | Description |
AlertPolicy.Condition.PrometheusQueryLanguageCondition.Builder | |
setDuration(Duration.Builder builderForValue)
public AlertPolicy.Condition.PrometheusQueryLanguageCondition.Builder setDuration(Duration.Builder builderForValue)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.
.google.protobuf.Duration duration = 2 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
builderForValue | Builder |
| Returns | |
|---|---|
| Type | Description |
AlertPolicy.Condition.PrometheusQueryLanguageCondition.Builder | |
setEvaluationInterval(Duration value)
public AlertPolicy.Condition.PrometheusQueryLanguageCondition.Builder setEvaluationInterval(Duration value)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.
.google.protobuf.Duration evaluation_interval = 3 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value | Duration |
| Returns | |
|---|---|
| Type | Description |
AlertPolicy.Condition.PrometheusQueryLanguageCondition.Builder | |
setEvaluationInterval(Duration.Builder builderForValue)
public AlertPolicy.Condition.PrometheusQueryLanguageCondition.Builder setEvaluationInterval(Duration.Builder builderForValue)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.
.google.protobuf.Duration evaluation_interval = 3 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
builderForValue | Builder |
| Returns | |
|---|---|
| Type | Description |
AlertPolicy.Condition.PrometheusQueryLanguageCondition.Builder | |
setField(Descriptors.FieldDescriptor field, Object value)
public AlertPolicy.Condition.PrometheusQueryLanguageCondition.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
value | Object |
| Returns | |
|---|---|
| Type | Description |
AlertPolicy.Condition.PrometheusQueryLanguageCondition.Builder | |
setQuery(String value)
public AlertPolicy.Condition.PrometheusQueryLanguageCondition.Builder setQuery(String value)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.
string query = 1 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value | StringThe query to set. |
| Returns | |
|---|---|
| Type | Description |
AlertPolicy.Condition.PrometheusQueryLanguageCondition.Builder | This builder for chaining. |
setQueryBytes(ByteString value)
public AlertPolicy.Condition.PrometheusQueryLanguageCondition.Builder setQueryBytes(ByteString value)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.
string query = 1 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for query to set. |
| Returns | |
|---|---|
| Type | Description |
AlertPolicy.Condition.PrometheusQueryLanguageCondition.Builder | This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public AlertPolicy.Condition.PrometheusQueryLanguageCondition.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
index | int |
value | Object |
| Returns | |
|---|---|
| Type | Description |
AlertPolicy.Condition.PrometheusQueryLanguageCondition.Builder | |
setRuleGroup(String value)
public AlertPolicy.Condition.PrometheusQueryLanguageCondition.Builder setRuleGroup(String value)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.
string rule_group = 5 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value | StringThe ruleGroup to set. |
| Returns | |
|---|---|
| Type | Description |
AlertPolicy.Condition.PrometheusQueryLanguageCondition.Builder | This builder for chaining. |
setRuleGroupBytes(ByteString value)
public AlertPolicy.Condition.PrometheusQueryLanguageCondition.Builder setRuleGroupBytes(ByteString value)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.
string rule_group = 5 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for ruleGroup to set. |
| Returns | |
|---|---|
| Type | Description |
AlertPolicy.Condition.PrometheusQueryLanguageCondition.Builder | This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final AlertPolicy.Condition.PrometheusQueryLanguageCondition.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields | UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
AlertPolicy.Condition.PrometheusQueryLanguageCondition.Builder | |