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

Class MetricThreshold

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

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

A condition type that compares a collection of time series against a threshold.

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

Method Summary

Modifier and Type	Method and Description
MetricThreshold	clone()
List<Aggregation>	getAggregations() Specifies the alignment of data points in individual time series as well as how to combine the retrieved time series together (such as when aggregating multiple streams on each resource to a single stream for each resource or when aggregating streams across all members of a group of resources).
String	getComparison() The comparison to apply between the time series (indicated by filter and aggregation) and the threshold (indicated by threshold_value).
List<Aggregation>	getDenominatorAggregations() Specifies the alignment of data points in individual time series selected by denominatorFilter as well as how to combine the retrieved time series together (such as when aggregating multiple streams on each resource to a single stream for each resource or when aggregating streams across all members of a group of resources).When computing ratios, the aggregations and denominator_aggregations fields must use the same alignment period and produce time series that have the same periodicity and labels.
String	getDenominatorFilter() A filter (https://cloud.google.com/monitoring/api/v3/filters) that identifies a time series that should be used as the denominator of a ratio that will be compared with the threshold.
String	getDuration() Required.
String	getEvaluationMissingData() A condition control that determines how metric-threshold conditions are evaluated when data stops arriving.
String	getFilter() Required.
ForecastOptions	getForecastOptions() When this field is present, the MetricThreshold condition forecasts whether the time series is predicted to violate the threshold within the forecast_horizon.
Double	getThresholdValue() A value against which to compare the time series.
Trigger	getTrigger() The number/percent of time series for which the comparison must hold in order for the condition to trigger.
MetricThreshold	set(String fieldName, Object value)
MetricThreshold	setAggregations(List<Aggregation> aggregations) Specifies the alignment of data points in individual time series as well as how to combine the retrieved time series together (such as when aggregating multiple streams on each resource to a single stream for each resource or when aggregating streams across all members of a group of resources).
MetricThreshold	setComparison(String comparison) The comparison to apply between the time series (indicated by filter and aggregation) and the threshold (indicated by threshold_value).
MetricThreshold	setDenominatorAggregations(List<Aggregation> denominatorAggregations) Specifies the alignment of data points in individual time series selected by denominatorFilter as well as how to combine the retrieved time series together (such as when aggregating multiple streams on each resource to a single stream for each resource or when aggregating streams across all members of a group of resources).When computing ratios, the aggregations and denominator_aggregations fields must use the same alignment period and produce time series that have the same periodicity and labels.
MetricThreshold	setDenominatorFilter(String denominatorFilter) A filter (https://cloud.google.com/monitoring/api/v3/filters) that identifies a time series that should be used as the denominator of a ratio that will be compared with the threshold.
MetricThreshold	setDuration(String duration) Required.
MetricThreshold	setEvaluationMissingData(String evaluationMissingData) A condition control that determines how metric-threshold conditions are evaluated when data stops arriving.
MetricThreshold	setFilter(String filter) Required.
MetricThreshold	setForecastOptions(ForecastOptions forecastOptions) When this field is present, the MetricThreshold condition forecasts whether the time series is predicted to violate the threshold within the forecast_horizon.
MetricThreshold	setThresholdValue(Double thresholdValue) A value against which to compare the time series.
MetricThreshold	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

MetricThreshold

public MetricThreshold()

Method Detail

getAggregations

public List<Aggregation> getAggregations()

Specifies the alignment of data points in individual time series as well as how to combine the retrieved time series together (such as when aggregating multiple streams on each resource to a single stream for each resource or when aggregating streams across all members of a group of resources). Multiple aggregations are applied in the order specified.This field is similar to the one in the ListTimeSeries request (https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.timeSeries/list). It is advisable to use the ListTimeSeries method when debugging this field.

Returns:

value or null for none

setAggregations

public MetricThreshold setAggregations(List<Aggregation> aggregations)

Specifies the alignment of data points in individual time series as well as how to combine the retrieved time series together (such as when aggregating multiple streams on each resource to a single stream for each resource or when aggregating streams across all members of a group of resources). Multiple aggregations are applied in the order specified.This field is similar to the one in the ListTimeSeries request (https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.timeSeries/list). It is advisable to use the ListTimeSeries method when debugging this field.

Parameters:

aggregations - aggregations or null for none

getComparison

public String getComparison()

The comparison to apply between the time series (indicated by filter and aggregation) and the threshold (indicated by threshold_value). The comparison is applied on each time series, with the time series on the left-hand side and the threshold on the right-hand side.Only COMPARISON_LT and COMPARISON_GT are supported currently.

Returns:

value or null for none

setComparison

public MetricThreshold setComparison(String comparison)

The comparison to apply between the time series (indicated by filter and aggregation) and the threshold (indicated by threshold_value). The comparison is applied on each time series, with the time series on the left-hand side and the threshold on the right-hand side.Only COMPARISON_LT and COMPARISON_GT are supported currently.

Parameters:

comparison - comparison or null for none

getDenominatorAggregations

public List<Aggregation> getDenominatorAggregations()

Specifies the alignment of data points in individual time series selected by denominatorFilter as well as how to combine the retrieved time series together (such as when aggregating multiple streams on each resource to a single stream for each resource or when aggregating streams across all members of a group of resources).When computing ratios, the aggregations and denominator_aggregations fields must use the same alignment period and produce time series that have the same periodicity and labels.

Returns:

value or null for none

setDenominatorAggregations

public MetricThreshold setDenominatorAggregations(List<Aggregation> denominatorAggregations)

Specifies the alignment of data points in individual time series selected by denominatorFilter as well as how to combine the retrieved time series together (such as when aggregating multiple streams on each resource to a single stream for each resource or when aggregating streams across all members of a group of resources).When computing ratios, the aggregations and denominator_aggregations fields must use the same alignment period and produce time series that have the same periodicity and labels.

Parameters:

denominatorAggregations - denominatorAggregations or null for none

getDenominatorFilter

public String getDenominatorFilter()

A filter (https://cloud.google.com/monitoring/api/v3/filters) that identifies a time series that should be used as the denominator of a ratio that will be compared with the threshold. If a denominator_filter is specified, the time series specified by the filter field will be used as the numerator.The filter must specify the metric type and optionally may contain restrictions on resource type, resource labels, and metric labels. This field may not exceed 2048 Unicode characters in length.

Returns:

value or null for none

setDenominatorFilter

public MetricThreshold setDenominatorFilter(String denominatorFilter)

A filter (https://cloud.google.com/monitoring/api/v3/filters) that identifies a time series that should be used as the denominator of a ratio that will be compared with the threshold. If a denominator_filter is specified, the time series specified by the filter field will be used as the numerator.The filter must specify the metric type and optionally may contain restrictions on resource type, resource labels, and metric labels. This field may not exceed 2048 Unicode characters in length.

Parameters:

denominatorFilter - denominatorFilter or null for none

getDuration

public String getDuration()

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

Returns:

value or null for none

setDuration

public MetricThreshold setDuration(String duration)

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

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. To use this control, the value of the duration field must be greater than or equal to 60 seconds.

Returns:

value or null for none

setEvaluationMissingData

public MetricThreshold setEvaluationMissingData(String evaluationMissingData)

A condition control that determines how metric-threshold conditions are evaluated when data stops arriving. To use this control, the value of the duration field must be greater than or equal to 60 seconds.

Parameters:

evaluationMissingData - evaluationMissingData or null for none

getFilter

public String getFilter()

Required. A filter (https://cloud.google.com/monitoring/api/v3/filters) that identifies which time series should be compared with the threshold.The filter is similar to the one that is specified in the ListTimeSeries request (https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.timeSeries/list) (that call is useful to verify the time series that will be retrieved / processed). The filter must specify the metric type and the resource type. Optionally, it can specify resource labels and metric labels. This field must not exceed 2048 Unicode characters in length.

Returns:

value or null for none

setFilter

public MetricThreshold setFilter(String filter)

Required. A filter (https://cloud.google.com/monitoring/api/v3/filters) that identifies which time series should be compared with the threshold.The filter is similar to the one that is specified in the ListTimeSeries request (https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.timeSeries/list) (that call is useful to verify the time series that will be retrieved / processed). The filter must specify the metric type and the resource type. Optionally, it can specify resource labels and metric labels. This field must not exceed 2048 Unicode characters in length.

Parameters:

filter - filter or null for none

getForecastOptions

public ForecastOptions getForecastOptions()

When this field is present, the MetricThreshold condition forecasts whether the time series is predicted to violate the threshold within the forecast_horizon. When this field is not set, the MetricThreshold tests the current value of the timeseries against the threshold.

Returns:

value or null for none

setForecastOptions

public MetricThreshold setForecastOptions(ForecastOptions forecastOptions)

When this field is present, the MetricThreshold condition forecasts whether the time series is predicted to violate the threshold within the forecast_horizon. When this field is not set, the MetricThreshold tests the current value of the timeseries against the threshold.

Parameters:

forecastOptions - forecastOptions or null for none

getThresholdValue

public Double getThresholdValue()

A value against which to compare the time series.

Returns:

value or null for none

setThresholdValue

public MetricThreshold setThresholdValue(Double thresholdValue)

A value against which to compare the time series.

Parameters:

thresholdValue - thresholdValue 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 MetricThreshold 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 MetricThreshold set(String fieldName,
                           Object value)

Overrides:

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

clone

public MetricThreshold clone()

Overrides:

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