Package com.google.monitoring.v3

Class AlertPolicy.Condition.MetricThreshold

    • Field Detail

      • AGGREGATIONS_FIELD_NUMBER

        public static final int AGGREGATIONS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • DENOMINATOR_FILTER_FIELD_NUMBER

        public static final int DENOMINATOR_FILTER_FIELD_NUMBER
        See Also:
        Constant Field Values

      • DENOMINATOR_AGGREGATIONS_FIELD_NUMBER

        public static final int DENOMINATOR_AGGREGATIONS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • FORECAST_OPTIONS_FIELD_NUMBER

        public static final int FORECAST_OPTIONS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • COMPARISON_FIELD_NUMBER

        public static final int COMPARISON_FIELD_NUMBER
        See Also:
        Constant Field Values

      • THRESHOLD_VALUE_FIELD_NUMBER

        public static final int THRESHOLD_VALUE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • EVALUATION_MISSING_DATA_FIELD_NUMBER

        public static final int EVALUATION_MISSING_DATA_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • getFilter

        public String getFilter()
         Required. A
 [filter](https://cloud.google.com/monitoring/api/v3/filters) that
 identifies which time series should be compared with the threshold.

 The filter is similar to the one that is specified in the
 [`ListTimeSeries`
 request](https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.timeSeries/list)
 (that call is useful to verify the time series that will be retrieved /
 processed). The filter must specify the metric type and the resource
 type. Optionally, it can specify resource labels and metric labels.
 This field must not exceed 2048 Unicode characters in length.
        string filter = 2 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getFilter in interface AlertPolicy.Condition.MetricThresholdOrBuilder
        Returns:
        The filter.

      • getFilterBytes

        public com.google.protobuf.ByteString getFilterBytes()
         Required. A
 [filter](https://cloud.google.com/monitoring/api/v3/filters) that
 identifies which time series should be compared with the threshold.

 The filter is similar to the one that is specified in the
 [`ListTimeSeries`
 request](https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.timeSeries/list)
 (that call is useful to verify the time series that will be retrieved /
 processed). The filter must specify the metric type and the resource
 type. Optionally, it can specify resource labels and metric labels.
 This field must not exceed 2048 Unicode characters in length.
        string filter = 2 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getFilterBytes in interface AlertPolicy.Condition.MetricThresholdOrBuilder
        Returns:
        The bytes for filter.

      • 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](https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.timeSeries/list).
 It is advisable to use the `ListTimeSeries` method when debugging this
 field.
        repeated .google.monitoring.v3.Aggregation aggregations = 8;
        Specified by:
        getAggregationsList in interface AlertPolicy.Condition.MetricThresholdOrBuilder

      • 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](https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.timeSeries/list).
 It is advisable to use the `ListTimeSeries` method when debugging this
 field.
        repeated .google.monitoring.v3.Aggregation aggregations = 8;
        Specified by:
        getAggregationsOrBuilderList in interface AlertPolicy.Condition.MetricThresholdOrBuilder

      • 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](https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.timeSeries/list).
 It is advisable to use the `ListTimeSeries` method when debugging this
 field.
        repeated .google.monitoring.v3.Aggregation aggregations = 8;
        Specified by:
        getAggregationsCount in interface AlertPolicy.Condition.MetricThresholdOrBuilder

      • getAggregations

        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](https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.timeSeries/list).
 It is advisable to use the `ListTimeSeries` method when debugging this
 field.
        repeated .google.monitoring.v3.Aggregation aggregations = 8;
        Specified by:
        getAggregations in interface AlertPolicy.Condition.MetricThresholdOrBuilder

      • getAggregationsOrBuilder

        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](https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.timeSeries/list).
 It is advisable to use the `ListTimeSeries` method when debugging this
 field.
        repeated .google.monitoring.v3.Aggregation aggregations = 8;
        Specified by:
        getAggregationsOrBuilder in interface AlertPolicy.Condition.MetricThresholdOrBuilder

      • getDenominatorFilter

        public String getDenominatorFilter()
         A [filter](https://cloud.google.com/monitoring/api/v3/filters) that
 identifies a time series that should be used as the denominator of a
 ratio that will be compared with the threshold. If a
 `denominator_filter` is specified, the time series specified by the
 `filter` field will be used as the numerator.

 The filter must specify the metric type and optionally may contain
 restrictions on resource type, resource labels, and metric labels.
 This field may not exceed 2048 Unicode characters in length.
        string denominator_filter = 9;
        Specified by:
        getDenominatorFilter in interface AlertPolicy.Condition.MetricThresholdOrBuilder
        Returns:
        The denominatorFilter.

      • getDenominatorFilterBytes

        public com.google.protobuf.ByteString getDenominatorFilterBytes()
         A [filter](https://cloud.google.com/monitoring/api/v3/filters) that
 identifies a time series that should be used as the denominator of a
 ratio that will be compared with the threshold. If a
 `denominator_filter` is specified, the time series specified by the
 `filter` field will be used as the numerator.

 The filter must specify the metric type and optionally may contain
 restrictions on resource type, resource labels, and metric labels.
 This field may not exceed 2048 Unicode characters in length.
        string denominator_filter = 9;
        Specified by:
        getDenominatorFilterBytes in interface AlertPolicy.Condition.MetricThresholdOrBuilder
        Returns:
        The bytes for denominatorFilter.

      • 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;
        Specified by:
        getDenominatorAggregationsList in interface AlertPolicy.Condition.MetricThresholdOrBuilder

      • 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;
        Specified by:
        getDenominatorAggregationsOrBuilderList in interface AlertPolicy.Condition.MetricThresholdOrBuilder

      • 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;
        Specified by:
        getDenominatorAggregationsCount in interface AlertPolicy.Condition.MetricThresholdOrBuilder

      • getDenominatorAggregations

        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;
        Specified by:
        getDenominatorAggregations in interface AlertPolicy.Condition.MetricThresholdOrBuilder

      • getDenominatorAggregationsOrBuilder

        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;
        Specified by:
        getDenominatorAggregationsOrBuilder in interface AlertPolicy.Condition.MetricThresholdOrBuilder

      • 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;
        Specified by:
        hasForecastOptions in interface AlertPolicy.Condition.MetricThresholdOrBuilder
        Returns:
        Whether the forecastOptions field is set.

      • 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;
        Specified by:
        getForecastOptions in interface AlertPolicy.Condition.MetricThresholdOrBuilder
        Returns:
        The forecastOptions.

      • 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;
        Specified by:
        getComparisonValue in interface AlertPolicy.Condition.MetricThresholdOrBuilder
        Returns:
        The enum numeric value on the wire for comparison.

      • 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;
        Specified by:
        getComparison in interface AlertPolicy.Condition.MetricThresholdOrBuilder
        Returns:
        The comparison.

      • 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;
        Specified by:
        hasDuration in interface AlertPolicy.Condition.MetricThresholdOrBuilder
        Returns:
        Whether the duration field is set.

      • getDuration

        public com.google.protobuf.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;
        Specified by:
        getDuration in interface AlertPolicy.Condition.MetricThresholdOrBuilder
        Returns:
        The duration.

      • getDurationOrBuilder

        public com.google.protobuf.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;
        Specified by:
        getDurationOrBuilder in interface AlertPolicy.Condition.MetricThresholdOrBuilder

      • 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;
        Specified by:
        hasTrigger in interface AlertPolicy.Condition.MetricThresholdOrBuilder
        Returns:
        Whether the trigger field is set.

      • 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;
        Specified by:
        getTrigger in interface AlertPolicy.Condition.MetricThresholdOrBuilder
        Returns:
        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;
        Specified by:
        getTriggerOrBuilder in interface AlertPolicy.Condition.MetricThresholdOrBuilder

      • 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;
        Specified by:
        getEvaluationMissingDataValue in interface AlertPolicy.Condition.MetricThresholdOrBuilder
        Returns:
        The enum numeric value on the wire for evaluationMissingData.

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static AlertPolicy.Condition.MetricThreshold parseFrom​(ByteBuffer data,
                                                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static AlertPolicy.Condition.MetricThreshold parseFrom​(com.google.protobuf.ByteString data)
                                                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static AlertPolicy.Condition.MetricThreshold parseFrom​(com.google.protobuf.ByteString data,
                                                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static AlertPolicy.Condition.MetricThreshold parseFrom​(byte[] data)
                                                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static AlertPolicy.Condition.MetricThreshold parseFrom​(byte[] data,
                                                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • newBuilderForType

        public AlertPolicy.Condition.MetricThreshold.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected AlertPolicy.Condition.MetricThreshold.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

        public com.google.protobuf.Parser<AlertPolicy.Condition.MetricThreshold> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public AlertPolicy.Condition.MetricThreshold getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder