# Cloud Monitoring V3 API - Class Google::Cloud::Monitoring::V3::AlertPolicy::Condition::MetricThreshold (v1.10.0)

1.10.0 (latest) 1.9.0 1.8.0 1.7.1 1.6.1 1.5.1 1.4.0 1.3.0 1.2.0 1.1.0 1.0.1 0.18.0 0.17.0 0.16.0 0.15.2 0.14.0 0.13.0 0.12.1 0.11.0 0.10.0 0.9.0 0.8.0 0.7.1 Reference documentation and code samples for the Cloud Monitoring V3 API class Google::Cloud::Monitoring::V3::AlertPolicy::Condition::MetricThreshold.

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

## Inherits

- Object

## Extended By

- Google::Protobuf::MessageExts::ClassMethods

## Includes

- Google::Protobuf::MessageExts

## Methods

### #aggregations

    def aggregations() -> ::Array<::Google::Cloud::Monitoring::V3::Aggregation>

**Returns**

- (::Array\<[::Google::Cloud::Monitoring::V3::Aggregation](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-monitoring-v3/latest/Google-Cloud-Monitoring-V3-Aggregation)\>) --- 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.

### #aggregations=

    def aggregations=(value) -> ::Array<::Google::Cloud::Monitoring::V3::Aggregation>

**Parameter**

- **value** (::Array\<[::Google::Cloud::Monitoring::V3::Aggregation](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-monitoring-v3/latest/Google-Cloud-Monitoring-V3-Aggregation)\>) --- 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.
**Returns**

- (::Array\<[::Google::Cloud::Monitoring::V3::Aggregation](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-monitoring-v3/latest/Google-Cloud-Monitoring-V3-Aggregation)\>) --- 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.

### #comparison

    def comparison() -> ::Google::Cloud::Monitoring::V3::ComparisonType

**Returns**

- ([::Google::Cloud::Monitoring::V3::ComparisonType](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-monitoring-v3/latest/Google-Cloud-Monitoring-V3-ComparisonType)) --- 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.

### #comparison=

    def comparison=(value) -> ::Google::Cloud::Monitoring::V3::ComparisonType

**Parameter**

- **value** ([::Google::Cloud::Monitoring::V3::ComparisonType](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-monitoring-v3/latest/Google-Cloud-Monitoring-V3-ComparisonType)) --- 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.
**Returns**

- ([::Google::Cloud::Monitoring::V3::ComparisonType](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-monitoring-v3/latest/Google-Cloud-Monitoring-V3-ComparisonType)) --- 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.

### #denominator_aggregations

    def denominator_aggregations() -> ::Array<::Google::Cloud::Monitoring::V3::Aggregation>

**Returns**

- (::Array\<[::Google::Cloud::Monitoring::V3::Aggregation](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-monitoring-v3/latest/Google-Cloud-Monitoring-V3-Aggregation)\>) --- 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.

### #denominator_aggregations=

    def denominator_aggregations=(value) -> ::Array<::Google::Cloud::Monitoring::V3::Aggregation>

**Parameter**

- **value** (::Array\<[::Google::Cloud::Monitoring::V3::Aggregation](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-monitoring-v3/latest/Google-Cloud-Monitoring-V3-Aggregation)\>) --- 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.
**Returns**

- (::Array\<[::Google::Cloud::Monitoring::V3::Aggregation](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-monitoring-v3/latest/Google-Cloud-Monitoring-V3-Aggregation)\>) --- 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.

### #denominator_filter

    def denominator_filter() -> ::String

**Returns**

- (::String) --- 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.

### #denominator_filter=

    def denominator_filter=(value) -> ::String

**Parameter**

- **value** (::String) --- 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.
**Returns**

- (::String) --- 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.

### #duration

    def duration() -> ::Google::Protobuf::Duration

**Returns**

- ([::Google::Protobuf::Duration](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-monitoring-v3/latest/Google-Protobuf-Duration)) --- 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.

### #duration=

    def duration=(value) -> ::Google::Protobuf::Duration

**Parameter**

- **value** ([::Google::Protobuf::Duration](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-monitoring-v3/latest/Google-Protobuf-Duration)) --- 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.
**Returns**

- ([::Google::Protobuf::Duration](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-monitoring-v3/latest/Google-Protobuf-Duration)) --- 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.

### #evaluation_missing_data

    def evaluation_missing_data() -> ::Google::Cloud::Monitoring::V3::AlertPolicy::Condition::EvaluationMissingData

**Returns**

- ([::Google::Cloud::Monitoring::V3::AlertPolicy::Condition::EvaluationMissingData](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-monitoring-v3/latest/Google-Cloud-Monitoring-V3-AlertPolicy-Condition-EvaluationMissingData)) --- A condition control that determines how metric-threshold conditions are evaluated when data stops arriving. To use this control, the value of the `duration` field must be greater than or equal to 60 seconds.

### #evaluation_missing_data=

    def evaluation_missing_data=(value) -> ::Google::Cloud::Monitoring::V3::AlertPolicy::Condition::EvaluationMissingData

**Parameter**

- **value** ([::Google::Cloud::Monitoring::V3::AlertPolicy::Condition::EvaluationMissingData](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-monitoring-v3/latest/Google-Cloud-Monitoring-V3-AlertPolicy-Condition-EvaluationMissingData)) --- A condition control that determines how metric-threshold conditions are evaluated when data stops arriving. To use this control, the value of the `duration` field must be greater than or equal to 60 seconds.
**Returns**

- ([::Google::Cloud::Monitoring::V3::AlertPolicy::Condition::EvaluationMissingData](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-monitoring-v3/latest/Google-Cloud-Monitoring-V3-AlertPolicy-Condition-EvaluationMissingData)) --- A condition control that determines how metric-threshold conditions are evaluated when data stops arriving. To use this control, the value of the `duration` field must be greater than or equal to 60 seconds.

### #filter

    def filter() -> ::String

**Returns**

- (::String) --- 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.

### #filter=

    def filter=(value) -> ::String

**Parameter**

- **value** (::String) --- 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.
**Returns**

- (::String) --- 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.

### #forecast_options

    def forecast_options() -> ::Google::Cloud::Monitoring::V3::AlertPolicy::Condition::MetricThreshold::ForecastOptions

**Returns**

- ([::Google::Cloud::Monitoring::V3::AlertPolicy::Condition::MetricThreshold::ForecastOptions](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-monitoring-v3/latest/Google-Cloud-Monitoring-V3-AlertPolicy-Condition-MetricThreshold-ForecastOptions)) --- 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.

### #forecast_options=

    def forecast_options=(value) -> ::Google::Cloud::Monitoring::V3::AlertPolicy::Condition::MetricThreshold::ForecastOptions

**Parameter**

- **value** ([::Google::Cloud::Monitoring::V3::AlertPolicy::Condition::MetricThreshold::ForecastOptions](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-monitoring-v3/latest/Google-Cloud-Monitoring-V3-AlertPolicy-Condition-MetricThreshold-ForecastOptions)) --- 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.
**Returns**

- ([::Google::Cloud::Monitoring::V3::AlertPolicy::Condition::MetricThreshold::ForecastOptions](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-monitoring-v3/latest/Google-Cloud-Monitoring-V3-AlertPolicy-Condition-MetricThreshold-ForecastOptions)) --- 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.

### #threshold_value

    def threshold_value() -> ::Float

**Returns**

- (::Float) --- A value against which to compare the time series.

### #threshold_value=

    def threshold_value=(value) -> ::Float

**Parameter**

- **value** (::Float) --- A value against which to compare the time series.
**Returns**

- (::Float) --- A value against which to compare the time series.

### #trigger

    def trigger() -> ::Google::Cloud::Monitoring::V3::AlertPolicy::Condition::Trigger

**Returns**

- ([::Google::Cloud::Monitoring::V3::AlertPolicy::Condition::Trigger](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-monitoring-v3/latest/Google-Cloud-Monitoring-V3-AlertPolicy-Condition-Trigger)) --- 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.

### #trigger=

    def trigger=(value) -> ::Google::Cloud::Monitoring::V3::AlertPolicy::Condition::Trigger

**Parameter**

- **value** ([::Google::Cloud::Monitoring::V3::AlertPolicy::Condition::Trigger](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-monitoring-v3/latest/Google-Cloud-Monitoring-V3-AlertPolicy-Condition-Trigger)) --- 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.
**Returns**

- ([::Google::Cloud::Monitoring::V3::AlertPolicy::Condition::Trigger](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-monitoring-v3/latest/Google-Cloud-Monitoring-V3-AlertPolicy-Condition-Trigger)) --- 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.