Package com.google.monitoring.v3

Interface AlertPolicy.Condition.MetricThresholdOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      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).
      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).
      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).
      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).
      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).
      ComparisonType getComparison()
      The comparison to apply between the time series (indicated by `filter` and `aggregation`) and the threshold (indicated by `threshold_value`).
      int getComparisonValue()
      The comparison to apply between the time series (indicated by `filter` and `aggregation`) and the threshold (indicated by `threshold_value`).
      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).
      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).
      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).
      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).
      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).
      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.
      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.
      com.google.protobuf.Duration getDuration()
      The amount of time that a time series must violate the threshold to be considered failing.
      com.google.protobuf.DurationOrBuilder getDurationOrBuilder()
      The amount of time that a time series must violate the threshold to be considered failing.
      AlertPolicy.Condition.EvaluationMissingData getEvaluationMissingData()
      A condition control that determines how metric-threshold conditions are evaluated when data stops arriving.
      int getEvaluationMissingDataValue()
      A condition control that determines how metric-threshold conditions are evaluated when data stops arriving.
      String getFilter()
      Required.
      com.google.protobuf.ByteString getFilterBytes()
      Required.
      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`.
      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`.
      double getThresholdValue()
      A value against which to compare the time series.
      AlertPolicy.Condition.Trigger getTrigger()
      The number/percent of time series for which the comparison must hold in order for the condition to trigger.
      AlertPolicy.Condition.TriggerOrBuilder getTriggerOrBuilder()
      The number/percent of time series for which the comparison must hold in order for the condition to trigger.
      boolean hasDuration()
      The amount of time that a time series must violate the threshold to be considered failing.
      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`.
      boolean hasTrigger()
      The number/percent of time series for which the comparison must hold in order for the condition to trigger.

      • Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

        isInitialized

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

    • Method Detail

      • getFilter

        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];
        Returns:
        The filter.

      • getFilterBytes

        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];
        Returns:
        The bytes for filter.

      • getAggregationsList

        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;

      • getAggregations

        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;

      • getAggregationsCount

        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;

      • getAggregationsOrBuilderList

        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;

      • getAggregationsOrBuilder

        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;

      • getDenominatorFilter

        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;
        Returns:
        The denominatorFilter.

      • getDenominatorFilterBytes

        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;
        Returns:
        The bytes for denominatorFilter.

      • getDenominatorAggregationsList

        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;

      • getDenominatorAggregations

        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;

      • getDenominatorAggregationsCount

        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;

      • getDenominatorAggregationsOrBuilderList

        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;

      • getDenominatorAggregationsOrBuilder

        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;

      • hasForecastOptions

        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:
        Whether the forecastOptions field is set.

      • getForecastOptions

        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:
        The forecastOptions.

      • getForecastOptionsOrBuilder

        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;

      • getComparisonValue

        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:
        The enum numeric value on the wire for comparison.

      • getComparison

        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:
        The comparison.

      • getThresholdValue

        double getThresholdValue()
         A value against which to compare the time series.
        double threshold_value = 5;
        Returns:
        The thresholdValue.

      • hasDuration

        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:
        Whether the duration field is set.

      • getDuration

        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;
        Returns:
        The duration.

      • getDurationOrBuilder

        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;

      • hasTrigger

        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:
        Whether the trigger field is set.

      • getTrigger

        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:
        The trigger.

      • getTriggerOrBuilder

        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;

      • getEvaluationMissingDataValue

        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:
        The enum numeric value on the wire for evaluationMissingData.

      • getEvaluationMissingData

        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:
        The evaluationMissingData.