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

Class MonitoringQueryLanguageCondition

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

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

A condition type that allows alerting policies to be defined using Monitoring Query Language (https://cloud.google.com/monitoring/mql).

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

Method Summary

Modifier and Type	Method and Description
MonitoringQueryLanguageCondition	clone()
String	getDuration() Optional.
String	getEvaluationMissingData() A condition control that determines how metric-threshold conditions are evaluated when data stops arriving.
String	getQuery() Monitoring Query Language (https://cloud.google.com/monitoring/mql) query that outputs a boolean stream.
Trigger	getTrigger() The number/percent of time series for which the comparison must hold in order for the condition to trigger.
MonitoringQueryLanguageCondition	set(String fieldName, Object value)
MonitoringQueryLanguageCondition	setDuration(String duration) Optional.
MonitoringQueryLanguageCondition	setEvaluationMissingData(String evaluationMissingData) A condition control that determines how metric-threshold conditions are evaluated when data stops arriving.
MonitoringQueryLanguageCondition	setQuery(String query) Monitoring Query Language (https://cloud.google.com/monitoring/mql) query that outputs a boolean stream.
MonitoringQueryLanguageCondition	setTrigger(Trigger trigger) The number/percent of time series for which the comparison must hold in order for the condition to trigger.

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

MonitoringQueryLanguageCondition

public MonitoringQueryLanguageCondition()

Method Detail

getDuration

public String getDuration()

Optional. The amount of time that a time series must violate the threshold to be considered failing. Currently, only values that are a multiple of a minute--e.g., 0, 60, 120, or 300 seconds--are supported. If an invalid value is given, an error will be returned. When choosing a duration, it is useful to keep in mind the frequency of the underlying time series data (which may also be affected by any alignments specified in the aggregations field); a good duration is long enough so that a single outlier does not generate spurious alerts, but short enough that unhealthy states are detected and alerted on quickly. The default value is zero.

Returns:

value or null for none

setDuration

public MonitoringQueryLanguageCondition setDuration(String duration)

Optional. The amount of time that a time series must violate the threshold to be considered failing. Currently, only values that are a multiple of a minute--e.g., 0, 60, 120, or 300 seconds--are supported. If an invalid value is given, an error will be returned. When choosing a duration, it is useful to keep in mind the frequency of the underlying time series data (which may also be affected by any alignments specified in the aggregations field); a good duration is long enough so that a single outlier does not generate spurious alerts, but short enough that unhealthy states are detected and alerted on quickly. The default value is zero.

Parameters:

duration - duration or null for none

getEvaluationMissingData

public String getEvaluationMissingData()

A condition control that determines how metric-threshold conditions are evaluated when data stops arriving.

Returns:

value or null for none

setEvaluationMissingData

public MonitoringQueryLanguageCondition setEvaluationMissingData(String evaluationMissingData)

A condition control that determines how metric-threshold conditions are evaluated when data stops arriving.

Parameters:

evaluationMissingData - evaluationMissingData or null for none

getQuery

public String getQuery()

Monitoring Query Language (https://cloud.google.com/monitoring/mql) query that outputs a boolean stream.

Returns:

value or null for none

setQuery

public MonitoringQueryLanguageCondition setQuery(String query)

Monitoring Query Language (https://cloud.google.com/monitoring/mql) query that outputs a boolean stream.

Parameters:

query - query or null for none

getTrigger

public Trigger getTrigger()

The number/percent of time series for which the comparison must hold in order for the condition to trigger. If unspecified, then the condition will trigger if the comparison is true for any of the time series that have been identified by filter and aggregations, or by the ratio, if denominator_filter and denominator_aggregations are specified.

Returns:

value or null for none

setTrigger

public MonitoringQueryLanguageCondition setTrigger(Trigger trigger)

The number/percent of time series for which the comparison must hold in order for the condition to trigger. If unspecified, then the condition will trigger if the comparison is true for any of the time series that have been identified by filter and aggregations, or by the ratio, if denominator_filter and denominator_aggregations are specified.

Parameters:

trigger - trigger or null for none

set

public MonitoringQueryLanguageCondition set(String fieldName,
                                            Object value)

Overrides:

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

clone

public MonitoringQueryLanguageCondition clone()

Overrides:

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