Class AlertPolicy.Condition.MetricThreshold.Builder (3.19.0)

public static final class AlertPolicy.Condition.MetricThreshold.Builder extends GeneratedMessageV3.Builder<AlertPolicy.Condition.MetricThreshold.Builder> 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

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addAggregations(Aggregation value)

public AlertPolicy.Condition.MetricThreshold.Builder addAggregations(Aggregation value)

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
NameDescription
valueAggregation
Returns
TypeDescription
AlertPolicy.Condition.MetricThreshold.Builder

addAggregations(Aggregation.Builder builderForValue)

public AlertPolicy.Condition.MetricThreshold.Builder addAggregations(Aggregation.Builder builderForValue)

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
NameDescription
builderForValueAggregation.Builder
Returns
TypeDescription
AlertPolicy.Condition.MetricThreshold.Builder

addAggregations(int index, Aggregation value)

public AlertPolicy.Condition.MetricThreshold.Builder addAggregations(int index, Aggregation value)

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;

Parameters
NameDescription
indexint
valueAggregation
Returns
TypeDescription
AlertPolicy.Condition.MetricThreshold.Builder

addAggregations(int index, Aggregation.Builder builderForValue)

public AlertPolicy.Condition.MetricThreshold.Builder addAggregations(int index, Aggregation.Builder builderForValue)

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;

Parameters
NameDescription
indexint
builderForValueAggregation.Builder
Returns
TypeDescription
AlertPolicy.Condition.MetricThreshold.Builder

addAggregationsBuilder()

public Aggregation.Builder addAggregationsBuilder()

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
TypeDescription
Aggregation.Builder

addAggregationsBuilder(int index)

public Aggregation.Builder addAggregationsBuilder(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
NameDescription
indexint
Returns
TypeDescription
Aggregation.Builder

addAllAggregations(Iterable<? extends Aggregation> values)

public AlertPolicy.Condition.MetricThreshold.Builder addAllAggregations(Iterable<? extends Aggregation> values)

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
NameDescription
valuesIterable<? extends com.google.monitoring.v3.Aggregation>
Returns
TypeDescription
AlertPolicy.Condition.MetricThreshold.Builder

addAllDenominatorAggregations(Iterable<? extends Aggregation> values)

public AlertPolicy.Condition.MetricThreshold.Builder addAllDenominatorAggregations(Iterable<? extends Aggregation> values)

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
NameDescription
valuesIterable<? extends com.google.monitoring.v3.Aggregation>
Returns
TypeDescription
AlertPolicy.Condition.MetricThreshold.Builder

addDenominatorAggregations(Aggregation value)

public AlertPolicy.Condition.MetricThreshold.Builder addDenominatorAggregations(Aggregation value)

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
NameDescription
valueAggregation
Returns
TypeDescription
AlertPolicy.Condition.MetricThreshold.Builder

addDenominatorAggregations(Aggregation.Builder builderForValue)

public AlertPolicy.Condition.MetricThreshold.Builder addDenominatorAggregations(Aggregation.Builder builderForValue)

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
NameDescription
builderForValueAggregation.Builder
Returns
TypeDescription
AlertPolicy.Condition.MetricThreshold.Builder

addDenominatorAggregations(int index, Aggregation value)

public AlertPolicy.Condition.MetricThreshold.Builder addDenominatorAggregations(int index, Aggregation value)

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;

Parameters
NameDescription
indexint
valueAggregation
Returns
TypeDescription
AlertPolicy.Condition.MetricThreshold.Builder

addDenominatorAggregations(int index, Aggregation.Builder builderForValue)

public AlertPolicy.Condition.MetricThreshold.Builder addDenominatorAggregations(int index, Aggregation.Builder builderForValue)

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;

Parameters
NameDescription
indexint
builderForValueAggregation.Builder
Returns
TypeDescription
AlertPolicy.Condition.MetricThreshold.Builder

addDenominatorAggregationsBuilder()

public Aggregation.Builder addDenominatorAggregationsBuilder()

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
TypeDescription
Aggregation.Builder

addDenominatorAggregationsBuilder(int index)

public Aggregation.Builder addDenominatorAggregationsBuilder(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
NameDescription
indexint
Returns
TypeDescription
Aggregation.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public AlertPolicy.Condition.MetricThreshold.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
AlertPolicy.Condition.MetricThreshold.Builder
Overrides

build()

public AlertPolicy.Condition.MetricThreshold build()
Returns
TypeDescription
AlertPolicy.Condition.MetricThreshold

buildPartial()

public AlertPolicy.Condition.MetricThreshold buildPartial()
Returns
TypeDescription
AlertPolicy.Condition.MetricThreshold

clear()

public AlertPolicy.Condition.MetricThreshold.Builder clear()
Returns
TypeDescription
AlertPolicy.Condition.MetricThreshold.Builder
Overrides

clearAggregations()

public AlertPolicy.Condition.MetricThreshold.Builder clearAggregations()

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
TypeDescription
AlertPolicy.Condition.MetricThreshold.Builder

clearComparison()

public AlertPolicy.Condition.MetricThreshold.Builder clearComparison()

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
TypeDescription
AlertPolicy.Condition.MetricThreshold.Builder

This builder for chaining.

clearDenominatorAggregations()

public AlertPolicy.Condition.MetricThreshold.Builder clearDenominatorAggregations()

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
TypeDescription
AlertPolicy.Condition.MetricThreshold.Builder

clearDenominatorFilter()

public AlertPolicy.Condition.MetricThreshold.Builder clearDenominatorFilter()

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
TypeDescription
AlertPolicy.Condition.MetricThreshold.Builder

This builder for chaining.

clearDuration()

public AlertPolicy.Condition.MetricThreshold.Builder clearDuration()

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
TypeDescription
AlertPolicy.Condition.MetricThreshold.Builder

clearEvaluationMissingData()

public AlertPolicy.Condition.MetricThreshold.Builder clearEvaluationMissingData()

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

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

Returns
TypeDescription
AlertPolicy.Condition.MetricThreshold.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public AlertPolicy.Condition.MetricThreshold.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
AlertPolicy.Condition.MetricThreshold.Builder
Overrides

clearFilter()

public AlertPolicy.Condition.MetricThreshold.Builder clearFilter()

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
TypeDescription
AlertPolicy.Condition.MetricThreshold.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public AlertPolicy.Condition.MetricThreshold.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
AlertPolicy.Condition.MetricThreshold.Builder
Overrides

clearThresholdValue()

public AlertPolicy.Condition.MetricThreshold.Builder clearThresholdValue()

A value against which to compare the time series.

double threshold_value = 5;

Returns
TypeDescription
AlertPolicy.Condition.MetricThreshold.Builder

This builder for chaining.

clearTrigger()

public AlertPolicy.Condition.MetricThreshold.Builder clearTrigger()

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
TypeDescription
AlertPolicy.Condition.MetricThreshold.Builder

clone()

public AlertPolicy.Condition.MetricThreshold.Builder clone()
Returns
TypeDescription
AlertPolicy.Condition.MetricThreshold.Builder
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
NameDescription
indexint
Returns
TypeDescription
Aggregation

getAggregationsBuilder(int index)

public Aggregation.Builder getAggregationsBuilder(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
NameDescription
indexint
Returns
TypeDescription
Aggregation.Builder

getAggregationsBuilderList()

public List<Aggregation.Builder> getAggregationsBuilderList()

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
TypeDescription
List<Builder>

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
TypeDescription
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
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
int

The enum numeric value on the wire for comparison.

getDefaultInstanceForType()

public AlertPolicy.Condition.MetricThreshold getDefaultInstanceForType()
Returns
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
Aggregation

getDenominatorAggregationsBuilder(int index)

public Aggregation.Builder getDenominatorAggregationsBuilder(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
NameDescription
indexint
Returns
TypeDescription
Aggregation.Builder

getDenominatorAggregationsBuilderList()

public List<Aggregation.Builder> getDenominatorAggregationsBuilderList()

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
TypeDescription
List<Builder>

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
TypeDescription
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
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for denominatorFilter.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

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
TypeDescription
Duration

The duration.

getDurationBuilder()

public Duration.Builder getDurationBuilder()

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
TypeDescription
Builder

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
TypeDescription
DurationOrBuilder

getEvaluationMissingData()

public AlertPolicy.Condition.EvaluationMissingData getEvaluationMissingData()

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

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

Returns
TypeDescription
AlertPolicy.Condition.EvaluationMissingData

The evaluationMissingData.

getEvaluationMissingDataValue()

public int getEvaluationMissingDataValue()

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

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

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for filter.

getThresholdValue()

public double getThresholdValue()

A value against which to compare the time series.

double threshold_value = 5;

Returns
TypeDescription
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
TypeDescription
AlertPolicy.Condition.Trigger

The trigger.

getTriggerBuilder()

public AlertPolicy.Condition.Trigger.Builder getTriggerBuilder()

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
TypeDescription
AlertPolicy.Condition.Trigger.Builder

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
TypeDescription
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
TypeDescription
boolean

Whether the duration 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
TypeDescription
boolean

Whether the trigger field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeDuration(Duration value)

public AlertPolicy.Condition.MetricThreshold.Builder mergeDuration(Duration value)

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;

Parameter
NameDescription
valueDuration
Returns
TypeDescription
AlertPolicy.Condition.MetricThreshold.Builder

mergeFrom(AlertPolicy.Condition.MetricThreshold other)

public AlertPolicy.Condition.MetricThreshold.Builder mergeFrom(AlertPolicy.Condition.MetricThreshold other)
Parameter
NameDescription
otherAlertPolicy.Condition.MetricThreshold
Returns
TypeDescription
AlertPolicy.Condition.MetricThreshold.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public AlertPolicy.Condition.MetricThreshold.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AlertPolicy.Condition.MetricThreshold.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public AlertPolicy.Condition.MetricThreshold.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
AlertPolicy.Condition.MetricThreshold.Builder
Overrides

mergeTrigger(AlertPolicy.Condition.Trigger value)

public AlertPolicy.Condition.MetricThreshold.Builder mergeTrigger(AlertPolicy.Condition.Trigger value)

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;

Parameter
NameDescription
valueAlertPolicy.Condition.Trigger
Returns
TypeDescription
AlertPolicy.Condition.MetricThreshold.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final AlertPolicy.Condition.MetricThreshold.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
AlertPolicy.Condition.MetricThreshold.Builder
Overrides

removeAggregations(int index)

public AlertPolicy.Condition.MetricThreshold.Builder removeAggregations(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
NameDescription
indexint
Returns
TypeDescription
AlertPolicy.Condition.MetricThreshold.Builder

removeDenominatorAggregations(int index)

public AlertPolicy.Condition.MetricThreshold.Builder removeDenominatorAggregations(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
NameDescription
indexint
Returns
TypeDescription
AlertPolicy.Condition.MetricThreshold.Builder

setAggregations(int index, Aggregation value)

public AlertPolicy.Condition.MetricThreshold.Builder setAggregations(int index, Aggregation value)

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;

Parameters
NameDescription
indexint
valueAggregation
Returns
TypeDescription
AlertPolicy.Condition.MetricThreshold.Builder

setAggregations(int index, Aggregation.Builder builderForValue)

public AlertPolicy.Condition.MetricThreshold.Builder setAggregations(int index, Aggregation.Builder builderForValue)

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;

Parameters
NameDescription
indexint
builderForValueAggregation.Builder
Returns
TypeDescription
AlertPolicy.Condition.MetricThreshold.Builder

setComparison(ComparisonType value)

public AlertPolicy.Condition.MetricThreshold.Builder setComparison(ComparisonType value)

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;

Parameter
NameDescription
valueComparisonType

The comparison to set.

Returns
TypeDescription
AlertPolicy.Condition.MetricThreshold.Builder

This builder for chaining.

setComparisonValue(int value)

public AlertPolicy.Condition.MetricThreshold.Builder setComparisonValue(int value)

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;

Parameter
NameDescription
valueint

The enum numeric value on the wire for comparison to set.

Returns
TypeDescription
AlertPolicy.Condition.MetricThreshold.Builder

This builder for chaining.

setDenominatorAggregations(int index, Aggregation value)

public AlertPolicy.Condition.MetricThreshold.Builder setDenominatorAggregations(int index, Aggregation value)

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;

Parameters
NameDescription
indexint
valueAggregation
Returns
TypeDescription
AlertPolicy.Condition.MetricThreshold.Builder

setDenominatorAggregations(int index, Aggregation.Builder builderForValue)

public AlertPolicy.Condition.MetricThreshold.Builder setDenominatorAggregations(int index, Aggregation.Builder builderForValue)

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;

Parameters
NameDescription
indexint
builderForValueAggregation.Builder
Returns
TypeDescription
AlertPolicy.Condition.MetricThreshold.Builder

setDenominatorFilter(String value)

public AlertPolicy.Condition.MetricThreshold.Builder setDenominatorFilter(String value)

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;

Parameter
NameDescription
valueString

The denominatorFilter to set.

Returns
TypeDescription
AlertPolicy.Condition.MetricThreshold.Builder

This builder for chaining.

setDenominatorFilterBytes(ByteString value)

public AlertPolicy.Condition.MetricThreshold.Builder setDenominatorFilterBytes(ByteString value)

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;

Parameter
NameDescription
valueByteString

The bytes for denominatorFilter to set.

Returns
TypeDescription
AlertPolicy.Condition.MetricThreshold.Builder

This builder for chaining.

setDuration(Duration value)

public AlertPolicy.Condition.MetricThreshold.Builder setDuration(Duration value)

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;

Parameter
NameDescription
valueDuration
Returns
TypeDescription
AlertPolicy.Condition.MetricThreshold.Builder

setDuration(Duration.Builder builderForValue)

public AlertPolicy.Condition.MetricThreshold.Builder setDuration(Duration.Builder builderForValue)

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;

Parameter
NameDescription
builderForValueBuilder
Returns
TypeDescription
AlertPolicy.Condition.MetricThreshold.Builder

setEvaluationMissingData(AlertPolicy.Condition.EvaluationMissingData value)

public AlertPolicy.Condition.MetricThreshold.Builder setEvaluationMissingData(AlertPolicy.Condition.EvaluationMissingData value)

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

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

Parameter
NameDescription
valueAlertPolicy.Condition.EvaluationMissingData

The evaluationMissingData to set.

Returns
TypeDescription
AlertPolicy.Condition.MetricThreshold.Builder

This builder for chaining.

setEvaluationMissingDataValue(int value)

public AlertPolicy.Condition.MetricThreshold.Builder setEvaluationMissingDataValue(int value)

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

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

Parameter
NameDescription
valueint

The enum numeric value on the wire for evaluationMissingData to set.

Returns
TypeDescription
AlertPolicy.Condition.MetricThreshold.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public AlertPolicy.Condition.MetricThreshold.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
AlertPolicy.Condition.MetricThreshold.Builder
Overrides

setFilter(String value)

public AlertPolicy.Condition.MetricThreshold.Builder setFilter(String value)

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];

Parameter
NameDescription
valueString

The filter to set.

Returns
TypeDescription
AlertPolicy.Condition.MetricThreshold.Builder

This builder for chaining.

setFilterBytes(ByteString value)

public AlertPolicy.Condition.MetricThreshold.Builder setFilterBytes(ByteString value)

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];

Parameter
NameDescription
valueByteString

The bytes for filter to set.

Returns
TypeDescription
AlertPolicy.Condition.MetricThreshold.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public AlertPolicy.Condition.MetricThreshold.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
AlertPolicy.Condition.MetricThreshold.Builder
Overrides

setThresholdValue(double value)

public AlertPolicy.Condition.MetricThreshold.Builder setThresholdValue(double value)

A value against which to compare the time series.

double threshold_value = 5;

Parameter
NameDescription
valuedouble

The thresholdValue to set.

Returns
TypeDescription
AlertPolicy.Condition.MetricThreshold.Builder

This builder for chaining.

setTrigger(AlertPolicy.Condition.Trigger value)

public AlertPolicy.Condition.MetricThreshold.Builder setTrigger(AlertPolicy.Condition.Trigger value)

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;

Parameter
NameDescription
valueAlertPolicy.Condition.Trigger
Returns
TypeDescription
AlertPolicy.Condition.MetricThreshold.Builder

setTrigger(AlertPolicy.Condition.Trigger.Builder builderForValue)

public AlertPolicy.Condition.MetricThreshold.Builder setTrigger(AlertPolicy.Condition.Trigger.Builder builderForValue)

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;

Parameter
NameDescription
builderForValueAlertPolicy.Condition.Trigger.Builder
Returns
TypeDescription
AlertPolicy.Condition.MetricThreshold.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final AlertPolicy.Condition.MetricThreshold.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
AlertPolicy.Condition.MetricThreshold.Builder
Overrides