Class AlertPolicy.Condition.MetricThreshold (3.47.0)

public static final class AlertPolicy.Condition.MetricThreshold extends GeneratedMessageV3 implements AlertPolicy.Condition.MetricThresholdOrBuilder

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

Protobuf type google.monitoring.v3.AlertPolicy.Condition.MetricThreshold

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > AlertPolicy.Condition.MetricThreshold

Static Fields

AGGREGATIONS_FIELD_NUMBER

public static final int AGGREGATIONS_FIELD_NUMBER
Field Value
Type Description
int

COMPARISON_FIELD_NUMBER

public static final int COMPARISON_FIELD_NUMBER
Field Value
Type Description
int

DENOMINATOR_AGGREGATIONS_FIELD_NUMBER

public static final int DENOMINATOR_AGGREGATIONS_FIELD_NUMBER
Field Value
Type Description
int

DENOMINATOR_FILTER_FIELD_NUMBER

public static final int DENOMINATOR_FILTER_FIELD_NUMBER
Field Value
Type Description
int

DURATION_FIELD_NUMBER

public static final int DURATION_FIELD_NUMBER
Field Value
Type Description
int

EVALUATION_MISSING_DATA_FIELD_NUMBER

public static final int EVALUATION_MISSING_DATA_FIELD_NUMBER
Field Value
Type Description
int

FILTER_FIELD_NUMBER

public static final int FILTER_FIELD_NUMBER
Field Value
Type Description
int

FORECAST_OPTIONS_FIELD_NUMBER

public static final int FORECAST_OPTIONS_FIELD_NUMBER
Field Value
Type Description
int

THRESHOLD_VALUE_FIELD_NUMBER

public static final int THRESHOLD_VALUE_FIELD_NUMBER
Field Value
Type Description
int

TRIGGER_FIELD_NUMBER

public static final int TRIGGER_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static AlertPolicy.Condition.MetricThreshold getDefaultInstance()
Returns
Type Description
AlertPolicy.Condition.MetricThreshold

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static AlertPolicy.Condition.MetricThreshold.Builder newBuilder()
Returns
Type Description
AlertPolicy.Condition.MetricThreshold.Builder

newBuilder(AlertPolicy.Condition.MetricThreshold prototype)

public static AlertPolicy.Condition.MetricThreshold.Builder newBuilder(AlertPolicy.Condition.MetricThreshold prototype)
Parameter
Name Description
prototype AlertPolicy.Condition.MetricThreshold
Returns
Type Description
AlertPolicy.Condition.MetricThreshold.Builder

parseDelimitedFrom(InputStream input)

public static AlertPolicy.Condition.MetricThreshold parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
AlertPolicy.Condition.MetricThreshold
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AlertPolicy.Condition.MetricThreshold parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AlertPolicy.Condition.MetricThreshold
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static AlertPolicy.Condition.MetricThreshold parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
AlertPolicy.Condition.MetricThreshold
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static AlertPolicy.Condition.MetricThreshold parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AlertPolicy.Condition.MetricThreshold
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static AlertPolicy.Condition.MetricThreshold parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
AlertPolicy.Condition.MetricThreshold
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static AlertPolicy.Condition.MetricThreshold parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AlertPolicy.Condition.MetricThreshold
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static AlertPolicy.Condition.MetricThreshold parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
AlertPolicy.Condition.MetricThreshold
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static AlertPolicy.Condition.MetricThreshold parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AlertPolicy.Condition.MetricThreshold
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static AlertPolicy.Condition.MetricThreshold parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
AlertPolicy.Condition.MetricThreshold
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AlertPolicy.Condition.MetricThreshold parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AlertPolicy.Condition.MetricThreshold
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static AlertPolicy.Condition.MetricThreshold parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
AlertPolicy.Condition.MetricThreshold
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static AlertPolicy.Condition.MetricThreshold parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AlertPolicy.Condition.MetricThreshold
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<AlertPolicy.Condition.MetricThreshold> parser()
Returns
Type Description
Parser<MetricThreshold>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getAggregations(int index)

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

getDefaultInstanceForType()

public AlertPolicy.Condition.MetricThreshold getDefaultInstanceForType()
Returns
Type Description
AlertPolicy.Condition.MetricThreshold

getDenominatorAggregations(int index)

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

getParserForType()

public Parser<AlertPolicy.Condition.MetricThreshold> getParserForType()
Returns
Type Description
Parser<MetricThreshold>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getThresholdValue()

public double getThresholdValue()

A value against which to compare the time series.

double threshold_value = 5;

Returns
Type Description
double

The thresholdValue.

getTrigger()

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

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public AlertPolicy.Condition.MetricThreshold.Builder newBuilderForType()
Returns
Type Description
AlertPolicy.Condition.MetricThreshold.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected AlertPolicy.Condition.MetricThreshold.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
AlertPolicy.Condition.MetricThreshold.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public AlertPolicy.Condition.MetricThreshold.Builder toBuilder()
Returns
Type Description
AlertPolicy.Condition.MetricThreshold.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException