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

Class MetricThreshold

java.lang.Object

java.util.AbstractMap<java.lang.String,java.lang.Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

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

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.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 Stackdriver 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

java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

java.util.Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
MetricThreshold()

Method Summary

Modifier and Type	Method and Description
MetricThreshold	clone()
java.util.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 resrouces).
java.lang.String	getComparison() The comparison to apply between the time series (indicated by filter and aggregation) and the threshold (indicated by threshold_value).
java.util.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.This field is similar to the one in the MetricService.ListTimeSeries request.
java.lang.String	getDenominatorFilter() A filter that identifies a time series that should be used as the denominator of a ratio that will be compared with the threshold.
java.lang.String	getDuration() The amount of time that a time series must violate the threshold to be considered failing.
java.lang.String	getFilter() A filter that identifies which time series should be compared with the threshold.The filter is similar to the one that is specified in the MetricService.ListTimeSeries request (that call is useful to verify the time series that will be retrieved / processed) and must specify the metric type and optionally may contain restrictions on resource type, resource labels, and metric labels.
java.lang.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(java.lang.String fieldName, java.lang.Object value)
MetricThreshold	setAggregations(java.util.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 resrouces).
MetricThreshold	setComparison(java.lang.String comparison) The comparison to apply between the time series (indicated by filter and aggregation) and the threshold (indicated by threshold_value).
MetricThreshold	setDenominatorAggregations(java.util.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.This field is similar to the one in the MetricService.ListTimeSeries request.
MetricThreshold	setDenominatorFilter(java.lang.String denominatorFilter) A filter that identifies a time series that should be used as the denominator of a ratio that will be compared with the threshold.
MetricThreshold	setDuration(java.lang.String duration) The amount of time that a time series must violate the threshold to be considered failing.
MetricThreshold	setFilter(java.lang.String filter) A filter that identifies which time series should be compared with the threshold.The filter is similar to the one that is specified in the MetricService.ListTimeSeries request (that call is useful to verify the time series that will be retrieved / processed) and must specify the metric type and optionally may contain restrictions on resource type, resource labels, and metric labels.
MetricThreshold	setThresholdValue(java.lang.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, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, equals, hashCode, 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 java.util.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 resrouces). Multiple aggregations are applied in the order specified.This field is similar to the one in the MetricService.ListTimeSeries request. It is advisable to use the ListTimeSeries method when debugging this field.

Returns:

value or null for none

setAggregations

public MetricThreshold setAggregations(java.util.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 resrouces). Multiple aggregations are applied in the order specified.This field is similar to the one in the MetricService.ListTimeSeries request. It is advisable to use the ListTimeSeries method when debugging this field.

Parameters:

aggregations - aggregations or null for none

getComparison

public java.lang.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(java.lang.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 java.util.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.This field is similar to the one in the MetricService.ListTimeSeries request. It is advisable to use the ListTimeSeries method when debugging this field.

Returns:

value or null for none

setDenominatorAggregations

public MetricThreshold setDenominatorAggregations(java.util.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.This field is similar to the one in the MetricService.ListTimeSeries request. It is advisable to use the ListTimeSeries method when debugging this field.

Parameters:

denominatorAggregations - denominatorAggregations or null for none

getDenominatorFilter

public java.lang.String getDenominatorFilter()

A filter 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 is similar to the one that is specified in the MetricService.ListTimeSeries request (that call is useful to verify the time series that will be retrieved / processed) and 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(java.lang.String denominatorFilter)

A filter 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 is similar to the one that is specified in the MetricService.ListTimeSeries request (that call is useful to verify the time series that will be retrieved / processed) and 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 java.lang.String getDuration()

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(java.lang.String duration)

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

getFilter

public java.lang.String getFilter()

A filter that identifies which time series should be compared with the threshold.The filter is similar to the one that is specified in the MetricService.ListTimeSeries request (that call is useful to verify the time series that will be retrieved / processed) and 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

setFilter

public MetricThreshold setFilter(java.lang.String filter)

A filter that identifies which time series should be compared with the threshold.The filter is similar to the one that is specified in the MetricService.ListTimeSeries request (that call is useful to verify the time series that will be retrieved / processed) and 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:

filter - filter or null for none

getThresholdValue

public java.lang.Double getThresholdValue()

A value against which to compare the time series.

Returns:

value or null for none

setThresholdValue

public MetricThreshold setThresholdValue(java.lang.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(java.lang.String fieldName,
                           java.lang.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