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

Class Condition

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

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

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.

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
Condition()

Method Summary

Modifier and Type	Method and Description
Condition	clone()
MetricAbsence	getConditionAbsent() A condition that checks that a time series continues to receive new data points.
LogMatch	getConditionMatchedLog() A condition that checks for log messages matching given constraints.
MonitoringQueryLanguageCondition	getConditionMonitoringQueryLanguage() A condition that uses the Monitoring Query Language to define alerts.
PrometheusQueryLanguageCondition	getConditionPrometheusQueryLanguage() A condition that uses the Prometheus query language to define alerts.
SqlCondition	getConditionSql() A condition that periodically evaluates a SQL query result.
MetricThreshold	getConditionThreshold() A condition that compares a time series against a threshold.
String	getDisplayName() A short name or phrase used to identify the condition in dashboards, notifications, and incidents.
String	getName() Required if the condition exists.
Condition	set(String fieldName, Object value)
Condition	setConditionAbsent(MetricAbsence conditionAbsent) A condition that checks that a time series continues to receive new data points.
Condition	setConditionMatchedLog(LogMatch conditionMatchedLog) A condition that checks for log messages matching given constraints.
Condition	setConditionMonitoringQueryLanguage(MonitoringQueryLanguageCondition conditionMonitoringQueryLanguage) A condition that uses the Monitoring Query Language to define alerts.
Condition	setConditionPrometheusQueryLanguage(PrometheusQueryLanguageCondition conditionPrometheusQueryLanguage) A condition that uses the Prometheus query language to define alerts.
Condition	setConditionSql(SqlCondition conditionSql) A condition that periodically evaluates a SQL query result.
Condition	setConditionThreshold(MetricThreshold conditionThreshold) A condition that compares a time series against a threshold.
Condition	setDisplayName(String displayName) A short name or phrase used to identify the condition in dashboards, notifications, and incidents.
Condition	setName(String name) Required if the condition exists.

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

Condition

public Condition()

Method Detail

getConditionAbsent

public MetricAbsence getConditionAbsent()

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

Returns:

value or null for none

setConditionAbsent

public Condition setConditionAbsent(MetricAbsence conditionAbsent)

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

Parameters:

conditionAbsent - conditionAbsent or null for none

getConditionMatchedLog

public LogMatch getConditionMatchedLog()

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

Returns:

value or null for none

setConditionMatchedLog

public Condition setConditionMatchedLog(LogMatch conditionMatchedLog)

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

Parameters:

conditionMatchedLog - conditionMatchedLog or null for none

getConditionMonitoringQueryLanguage

public MonitoringQueryLanguageCondition getConditionMonitoringQueryLanguage()

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

Returns:

value or null for none

setConditionMonitoringQueryLanguage

public Condition setConditionMonitoringQueryLanguage(MonitoringQueryLanguageCondition conditionMonitoringQueryLanguage)

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

Parameters:

conditionMonitoringQueryLanguage - conditionMonitoringQueryLanguage or null for none

getConditionPrometheusQueryLanguage

public PrometheusQueryLanguageCondition getConditionPrometheusQueryLanguage()

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

Returns:

value or null for none

setConditionPrometheusQueryLanguage

public Condition setConditionPrometheusQueryLanguage(PrometheusQueryLanguageCondition conditionPrometheusQueryLanguage)

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

Parameters:

conditionPrometheusQueryLanguage - conditionPrometheusQueryLanguage or null for none

getConditionSql

public SqlCondition getConditionSql()

A condition that periodically evaluates a SQL query result.

Returns:

value or null for none

setConditionSql

public Condition setConditionSql(SqlCondition conditionSql)

A condition that periodically evaluates a SQL query result.

Parameters:

conditionSql - conditionSql or null for none

getConditionThreshold

public MetricThreshold getConditionThreshold()

A condition that compares a time series against a threshold.

Returns:

value or null for none

setConditionThreshold

public Condition setConditionThreshold(MetricThreshold conditionThreshold)

A condition that compares a time series against a threshold.

Parameters:

conditionThreshold - conditionThreshold or null for none

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.

Returns:

value or null for none

setDisplayName

public Condition setDisplayName(String displayName)

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.

Parameters:

displayName - displayName or null for none

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.

Returns:

value or null for none

setName

public Condition setName(String name)

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.

Parameters:

name - name or null for none

set

public Condition set(String fieldName,
                     Object value)

Overrides:

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

clone

public Condition clone()

Overrides:

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