Class AlertPolicy.Condition (3.48.0)

public static final class AlertPolicy.Condition extends GeneratedMessageV3 implements AlertPolicy.ConditionOrBuilder

A condition is a true/false test that determines when an alerting policy should open an incident. If a condition evaluates to true, it signifies that something is wrong.

Protobuf type google.monitoring.v3.AlertPolicy.Condition

Static Fields

CONDITION_ABSENT_FIELD_NUMBER

public static final int CONDITION_ABSENT_FIELD_NUMBER
Field Value
Type Description
int

CONDITION_MATCHED_LOG_FIELD_NUMBER

public static final int CONDITION_MATCHED_LOG_FIELD_NUMBER
Field Value
Type Description
int

CONDITION_MONITORING_QUERY_LANGUAGE_FIELD_NUMBER

public static final int CONDITION_MONITORING_QUERY_LANGUAGE_FIELD_NUMBER
Field Value
Type Description
int

CONDITION_PROMETHEUS_QUERY_LANGUAGE_FIELD_NUMBER

public static final int CONDITION_PROMETHEUS_QUERY_LANGUAGE_FIELD_NUMBER
Field Value
Type Description
int

CONDITION_THRESHOLD_FIELD_NUMBER

public static final int CONDITION_THRESHOLD_FIELD_NUMBER
Field Value
Type Description
int

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static AlertPolicy.Condition getDefaultInstance()
Returns
Type Description
AlertPolicy.Condition

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static AlertPolicy.Condition.Builder newBuilder()
Returns
Type Description
AlertPolicy.Condition.Builder

newBuilder(AlertPolicy.Condition prototype)

public static AlertPolicy.Condition.Builder newBuilder(AlertPolicy.Condition prototype)
Parameter
Name Description
prototype AlertPolicy.Condition
Returns
Type Description
AlertPolicy.Condition.Builder

parseDelimitedFrom(InputStream input)

public static AlertPolicy.Condition parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
AlertPolicy.Condition
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AlertPolicy.Condition parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AlertPolicy.Condition
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static AlertPolicy.Condition parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
AlertPolicy.Condition
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static AlertPolicy.Condition parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AlertPolicy.Condition
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static AlertPolicy.Condition parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
AlertPolicy.Condition
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static AlertPolicy.Condition parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AlertPolicy.Condition
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static AlertPolicy.Condition parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
AlertPolicy.Condition
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static AlertPolicy.Condition parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AlertPolicy.Condition
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static AlertPolicy.Condition parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
AlertPolicy.Condition
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AlertPolicy.Condition parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AlertPolicy.Condition
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static AlertPolicy.Condition parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
AlertPolicy.Condition
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static AlertPolicy.Condition parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AlertPolicy.Condition
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<AlertPolicy.Condition> parser()
Returns
Type Description
Parser<Condition>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getConditionAbsent()

public AlertPolicy.Condition.MetricAbsence getConditionAbsent()

A condition that checks that a time series continues to receive new data points.

.google.monitoring.v3.AlertPolicy.Condition.MetricAbsence condition_absent = 2;

Returns
Type Description
AlertPolicy.Condition.MetricAbsence

The conditionAbsent.

getConditionAbsentOrBuilder()

public AlertPolicy.Condition.MetricAbsenceOrBuilder getConditionAbsentOrBuilder()

A condition that checks that a time series continues to receive new data points.

.google.monitoring.v3.AlertPolicy.Condition.MetricAbsence condition_absent = 2;

Returns
Type Description
AlertPolicy.Condition.MetricAbsenceOrBuilder

getConditionCase()

public AlertPolicy.Condition.ConditionCase getConditionCase()
Returns
Type Description
AlertPolicy.Condition.ConditionCase

getConditionMatchedLog()

public AlertPolicy.Condition.LogMatch getConditionMatchedLog()

A condition that checks for log messages matching given constraints. If set, no other conditions can be present.

.google.monitoring.v3.AlertPolicy.Condition.LogMatch condition_matched_log = 20;

Returns
Type Description
AlertPolicy.Condition.LogMatch

The conditionMatchedLog.

getConditionMatchedLogOrBuilder()

public AlertPolicy.Condition.LogMatchOrBuilder getConditionMatchedLogOrBuilder()

A condition that checks for log messages matching given constraints. If set, no other conditions can be present.

.google.monitoring.v3.AlertPolicy.Condition.LogMatch condition_matched_log = 20;

Returns
Type Description
AlertPolicy.Condition.LogMatchOrBuilder

getConditionMonitoringQueryLanguage()

public AlertPolicy.Condition.MonitoringQueryLanguageCondition getConditionMonitoringQueryLanguage()

A condition that uses the Monitoring Query Language to define alerts.

.google.monitoring.v3.AlertPolicy.Condition.MonitoringQueryLanguageCondition condition_monitoring_query_language = 19;

Returns
Type Description
AlertPolicy.Condition.MonitoringQueryLanguageCondition

The conditionMonitoringQueryLanguage.

getConditionMonitoringQueryLanguageOrBuilder()

public AlertPolicy.Condition.MonitoringQueryLanguageConditionOrBuilder getConditionMonitoringQueryLanguageOrBuilder()

A condition that uses the Monitoring Query Language to define alerts.

.google.monitoring.v3.AlertPolicy.Condition.MonitoringQueryLanguageCondition condition_monitoring_query_language = 19;

Returns
Type Description
AlertPolicy.Condition.MonitoringQueryLanguageConditionOrBuilder

getConditionPrometheusQueryLanguage()

public AlertPolicy.Condition.PrometheusQueryLanguageCondition getConditionPrometheusQueryLanguage()

A condition that uses the Prometheus query language to define alerts.

.google.monitoring.v3.AlertPolicy.Condition.PrometheusQueryLanguageCondition condition_prometheus_query_language = 21;

Returns
Type Description
AlertPolicy.Condition.PrometheusQueryLanguageCondition

The conditionPrometheusQueryLanguage.

getConditionPrometheusQueryLanguageOrBuilder()

public AlertPolicy.Condition.PrometheusQueryLanguageConditionOrBuilder getConditionPrometheusQueryLanguageOrBuilder()

A condition that uses the Prometheus query language to define alerts.

.google.monitoring.v3.AlertPolicy.Condition.PrometheusQueryLanguageCondition condition_prometheus_query_language = 21;

Returns
Type Description
AlertPolicy.Condition.PrometheusQueryLanguageConditionOrBuilder

getConditionThreshold()

public AlertPolicy.Condition.MetricThreshold getConditionThreshold()

A condition that compares a time series against a threshold.

.google.monitoring.v3.AlertPolicy.Condition.MetricThreshold condition_threshold = 1;

Returns
Type Description
AlertPolicy.Condition.MetricThreshold

The conditionThreshold.

getConditionThresholdOrBuilder()

public AlertPolicy.Condition.MetricThresholdOrBuilder getConditionThresholdOrBuilder()

A condition that compares a time series against a threshold.

.google.monitoring.v3.AlertPolicy.Condition.MetricThreshold condition_threshold = 1;

Returns
Type Description
AlertPolicy.Condition.MetricThresholdOrBuilder

getDefaultInstanceForType()

public AlertPolicy.Condition getDefaultInstanceForType()
Returns
Type Description
AlertPolicy.Condition

getDisplayName()

public String getDisplayName()

A short name or phrase used to identify the condition in dashboards, notifications, and incidents. To avoid confusion, don't use the same display name for multiple conditions in the same policy.

string display_name = 6;

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

A short name or phrase used to identify the condition in dashboards, notifications, and incidents. To avoid confusion, don't use the same display name for multiple conditions in the same policy.

string display_name = 6;

Returns
Type Description
ByteString

The bytes for displayName.

getName()

public String getName()

Required if the condition exists. The unique resource name for this condition. Its format is:

 projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[POLICY_ID]/conditions/[CONDITION_ID]

[CONDITION_ID] is assigned by Cloud Monitoring when the condition is created as part of a new or updated alerting policy.

When calling the alertPolicies.create method, do not include the name field in the conditions of the requested alerting policy. Cloud Monitoring creates the condition identifiers and includes them in the new policy.

When calling the alertPolicies.update method to update a policy, including a condition name causes the existing condition to be updated. Conditions without names are added to the updated policy. Existing conditions are deleted if they are not updated.

Best practice is to preserve [CONDITION_ID] if you make only small changes, such as those to condition thresholds, durations, or trigger values. Otherwise, treat the change as a new condition and let the existing condition be deleted.

string name = 12;

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Required if the condition exists. The unique resource name for this condition. Its format is:

 projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[POLICY_ID]/conditions/[CONDITION_ID]

[CONDITION_ID] is assigned by Cloud Monitoring when the condition is created as part of a new or updated alerting policy.

When calling the alertPolicies.create method, do not include the name field in the conditions of the requested alerting policy. Cloud Monitoring creates the condition identifiers and includes them in the new policy.

When calling the alertPolicies.update method to update a policy, including a condition name causes the existing condition to be updated. Conditions without names are added to the updated policy. Existing conditions are deleted if they are not updated.

Best practice is to preserve [CONDITION_ID] if you make only small changes, such as those to condition thresholds, durations, or trigger values. Otherwise, treat the change as a new condition and let the existing condition be deleted.

string name = 12;

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

public Parser<AlertPolicy.Condition> getParserForType()
Returns
Type Description
Parser<Condition>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasConditionAbsent()

public boolean hasConditionAbsent()

A condition that checks that a time series continues to receive new data points.

.google.monitoring.v3.AlertPolicy.Condition.MetricAbsence condition_absent = 2;

Returns
Type Description
boolean

Whether the conditionAbsent field is set.

hasConditionMatchedLog()

public boolean hasConditionMatchedLog()

A condition that checks for log messages matching given constraints. If set, no other conditions can be present.

.google.monitoring.v3.AlertPolicy.Condition.LogMatch condition_matched_log = 20;

Returns
Type Description
boolean

Whether the conditionMatchedLog field is set.

hasConditionMonitoringQueryLanguage()

public boolean hasConditionMonitoringQueryLanguage()

A condition that uses the Monitoring Query Language to define alerts.

.google.monitoring.v3.AlertPolicy.Condition.MonitoringQueryLanguageCondition condition_monitoring_query_language = 19;

Returns
Type Description
boolean

Whether the conditionMonitoringQueryLanguage field is set.

hasConditionPrometheusQueryLanguage()

public boolean hasConditionPrometheusQueryLanguage()

A condition that uses the Prometheus query language to define alerts.

.google.monitoring.v3.AlertPolicy.Condition.PrometheusQueryLanguageCondition condition_prometheus_query_language = 21;

Returns
Type Description
boolean

Whether the conditionPrometheusQueryLanguage field is set.

hasConditionThreshold()

public boolean hasConditionThreshold()

A condition that compares a time series against a threshold.

.google.monitoring.v3.AlertPolicy.Condition.MetricThreshold condition_threshold = 1;

Returns
Type Description
boolean

Whether the conditionThreshold field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public AlertPolicy.Condition.Builder newBuilderForType()
Returns
Type Description
AlertPolicy.Condition.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected AlertPolicy.Condition.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
AlertPolicy.Condition.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public AlertPolicy.Condition.Builder toBuilder()
Returns
Type Description
AlertPolicy.Condition.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException