Stackdriver Monitoring V3 Client - Class MetricThreshold (1.2.2)

Reference documentation and code samples for the Stackdriver Monitoring V3 Client class MetricThreshold.

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

Generated from protobuf message google.monitoring.v3.AlertPolicy.Condition.MetricThreshold

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ filter`	`string` 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.
`↳ aggregations`	`array<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. It is advisable to use the `ListTimeSeries` method when debugging this field.
`↳ denominator_filter`	`string` 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.
`↳ denominator_aggregations`	`array<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.
`↳ comparison`	`int` 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.
`↳ threshold_value`	`float` A value against which to compare the time series.
`↳ duration`	`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.
`↳ trigger`	`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.
`↳ evaluation_missing_data`	`int` A condition control that determines how metric-threshold conditions are evaluated when data stops arriving.

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.

Generated from protobuf field string filter = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`string`

setFilter

Required. A filter that identifies which time series should be compared with the threshold.

Generated from protobuf field string filter = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getAggregations

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.

Generated from protobuf field repeated .google.monitoring.v3.Aggregation aggregations = 8;

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setAggregations

This field is similar to the one in the ListTimeSeries request. It is advisable to use the ListTimeSeries method when debugging this field.

Generated from protobuf field repeated .google.monitoring.v3.Aggregation aggregations = 8;

Parameter
Name	Description
`var`	`array<Google\Cloud\Monitoring\V3\Aggregation>`

Returns
Type	Description
`$this`

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.

Generated from protobuf field string denominator_filter = 9;

Returns
Type	Description
`string`

setDenominatorFilter

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.

Generated from protobuf field string denominator_filter = 9;

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getDenominatorAggregations

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.

Generated from protobuf field repeated .google.monitoring.v3.Aggregation denominator_aggregations = 10;

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setDenominatorAggregations

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.

Generated from protobuf field repeated .google.monitoring.v3.Aggregation denominator_aggregations = 10;

Parameter
Name	Description
`var`	`array<Google\Cloud\Monitoring\V3\Aggregation>`

Returns
Type	Description
`$this`

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.

Generated from protobuf field .google.monitoring.v3.ComparisonType comparison = 4;

Returns
Type	Description
`int`

setComparison

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.

Generated from protobuf field .google.monitoring.v3.ComparisonType comparison = 4;

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getThresholdValue

A value against which to compare the time series.

Generated from protobuf field double threshold_value = 5;

Returns
Type	Description
`float`

setThresholdValue

A value against which to compare the time series.

Generated from protobuf field double threshold_value = 5;

Parameter
Name	Description
`var`	`float`

Returns
Type	Description
`$this`

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.

Generated from protobuf field .google.protobuf.Duration duration = 6;

Returns
Type	Description
`Google\Protobuf\Duration\|null`

hasDuration

clearDuration

setDuration

Generated from protobuf field .google.protobuf.Duration duration = 6;

Parameter
Name	Description
`var`	`Google\Protobuf\Duration`

Returns
Type	Description
`$this`

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.

Generated from protobuf field .google.monitoring.v3.AlertPolicy.Condition.Trigger trigger = 7;

Returns
Type	Description
`Google\Cloud\Monitoring\V3\AlertPolicy\Condition\Trigger\|null`

hasTrigger

clearTrigger

setTrigger

Generated from protobuf field .google.monitoring.v3.AlertPolicy.Condition.Trigger trigger = 7;

Parameter
Name	Description
`var`	`Google\Cloud\Monitoring\V3\AlertPolicy\Condition\Trigger`

Returns
Type	Description
`$this`

getEvaluationMissingData

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

Generated from protobuf field .google.monitoring.v3.AlertPolicy.Condition.EvaluationMissingData evaluation_missing_data = 11;

Returns
Type	Description
`int`

setEvaluationMissingData

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

Generated from protobuf field .google.monitoring.v3.AlertPolicy.Condition.EvaluationMissingData evaluation_missing_data = 11;

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`