Interface AlertPolicy.Condition.MetricThresholdOrBuilder (3.48.0)

public static interface AlertPolicy.Condition.MetricThresholdOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAggregations(int index)

public abstract Aggregation getAggregations(int index)

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. It is advisable to use the ListTimeSeries method when debugging this field.

repeated .google.monitoring.v3.Aggregation aggregations = 8;

Parameter
Name Description
index int
Returns
Type Description
Aggregation

getAggregationsCount()

public abstract int getAggregationsCount()

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. It is advisable to use the ListTimeSeries method when debugging this field.

repeated .google.monitoring.v3.Aggregation aggregations = 8;

Returns
Type Description
int

getAggregationsList()

public abstract List<Aggregation> getAggregationsList()

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. It is advisable to use the ListTimeSeries method when debugging this field.

repeated .google.monitoring.v3.Aggregation aggregations = 8;

Returns
Type Description
List<Aggregation>

getAggregationsOrBuilder(int index)

public abstract AggregationOrBuilder getAggregationsOrBuilder(int index)

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. It is advisable to use the ListTimeSeries method when debugging this field.

repeated .google.monitoring.v3.Aggregation aggregations = 8;

Parameter
Name Description
index int
Returns
Type Description
AggregationOrBuilder

getAggregationsOrBuilderList()

public abstract List<? extends AggregationOrBuilder> getAggregationsOrBuilderList()

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. It is advisable to use the ListTimeSeries method when debugging this field.

repeated .google.monitoring.v3.Aggregation aggregations = 8;

Returns
Type Description
List<? extends com.google.monitoring.v3.AggregationOrBuilder>

getComparison()

public abstract ComparisonType 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.

.google.monitoring.v3.ComparisonType comparison = 4;

Returns
Type Description
ComparisonType

The comparison.

getComparisonValue()

public abstract int getComparisonValue()

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.

.google.monitoring.v3.ComparisonType comparison = 4;

Returns
Type Description
int

The enum numeric value on the wire for comparison.

getDenominatorAggregations(int index)

public abstract Aggregation getDenominatorAggregations(int index)

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.

repeated .google.monitoring.v3.Aggregation denominator_aggregations = 10;

Parameter
Name Description
index int
Returns
Type Description
Aggregation

getDenominatorAggregationsCount()

public abstract int getDenominatorAggregationsCount()

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.

repeated .google.monitoring.v3.Aggregation denominator_aggregations = 10;

Returns
Type Description
int

getDenominatorAggregationsList()

public abstract List<Aggregation> getDenominatorAggregationsList()

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.

repeated .google.monitoring.v3.Aggregation denominator_aggregations = 10;

Returns
Type Description
List<Aggregation>

getDenominatorAggregationsOrBuilder(int index)

public abstract AggregationOrBuilder getDenominatorAggregationsOrBuilder(int index)

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.

repeated .google.monitoring.v3.Aggregation denominator_aggregations = 10;

Parameter
Name Description
index int
Returns
Type Description
AggregationOrBuilder

getDenominatorAggregationsOrBuilderList()

public abstract List<? extends AggregationOrBuilder> getDenominatorAggregationsOrBuilderList()

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.

repeated .google.monitoring.v3.Aggregation denominator_aggregations = 10;

Returns
Type Description
List<? extends com.google.monitoring.v3.AggregationOrBuilder>

getDenominatorFilter()

public abstract 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 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.

string denominator_filter = 9;

Returns
Type Description
String

The denominatorFilter.

getDenominatorFilterBytes()

public abstract ByteString getDenominatorFilterBytes()

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

string denominator_filter = 9;

Returns
Type Description
ByteString

The bytes for denominatorFilter.

getDuration()

public abstract Duration 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.

.google.protobuf.Duration duration = 6;

Returns
Type Description
Duration

The duration.

getDurationOrBuilder()

public abstract DurationOrBuilder getDurationOrBuilder()

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.

.google.protobuf.Duration duration = 6;

Returns
Type Description
DurationOrBuilder

getEvaluationMissingData()

public abstract AlertPolicy.Condition.EvaluationMissingData 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.

.google.monitoring.v3.AlertPolicy.Condition.EvaluationMissingData evaluation_missing_data = 11;

Returns
Type Description
AlertPolicy.Condition.EvaluationMissingData

The evaluationMissingData.

getEvaluationMissingDataValue()

public abstract int getEvaluationMissingDataValue()

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.

.google.monitoring.v3.AlertPolicy.Condition.EvaluationMissingData evaluation_missing_data = 11;

Returns
Type Description
int

The enum numeric value on the wire for evaluationMissingData.

getFilter()

public abstract String getFilter()

Required. 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 ListTimeSeries request (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.

string filter = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The filter.

getFilterBytes()

public abstract ByteString getFilterBytes()

Required. 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 ListTimeSeries request (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.

string filter = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for filter.

getForecastOptions()

public abstract AlertPolicy.Condition.MetricThreshold.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.

.google.monitoring.v3.AlertPolicy.Condition.MetricThreshold.ForecastOptions forecast_options = 12;

Returns
Type Description
AlertPolicy.Condition.MetricThreshold.ForecastOptions

The forecastOptions.

getForecastOptionsOrBuilder()

public abstract AlertPolicy.Condition.MetricThreshold.ForecastOptionsOrBuilder getForecastOptionsOrBuilder()

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.

.google.monitoring.v3.AlertPolicy.Condition.MetricThreshold.ForecastOptions forecast_options = 12;

Returns
Type Description
AlertPolicy.Condition.MetricThreshold.ForecastOptionsOrBuilder

getThresholdValue()

public abstract double getThresholdValue()

A value against which to compare the time series.

double threshold_value = 5;

Returns
Type Description
double

The thresholdValue.

getTrigger()

public abstract AlertPolicy.Condition.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.

.google.monitoring.v3.AlertPolicy.Condition.Trigger trigger = 7;

Returns
Type Description
AlertPolicy.Condition.Trigger

The trigger.

getTriggerOrBuilder()

public abstract AlertPolicy.Condition.TriggerOrBuilder getTriggerOrBuilder()

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.

.google.monitoring.v3.AlertPolicy.Condition.Trigger trigger = 7;

Returns
Type Description
AlertPolicy.Condition.TriggerOrBuilder

hasDuration()

public abstract boolean hasDuration()

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.

.google.protobuf.Duration duration = 6;

Returns
Type Description
boolean

Whether the duration field is set.

hasForecastOptions()

public abstract boolean hasForecastOptions()

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.

.google.monitoring.v3.AlertPolicy.Condition.MetricThreshold.ForecastOptions forecast_options = 12;

Returns
Type Description
boolean

Whether the forecastOptions field is set.

hasTrigger()

public abstract boolean hasTrigger()

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.

.google.monitoring.v3.AlertPolicy.Condition.Trigger trigger = 7;

Returns
Type Description
boolean

Whether the trigger field is set.