Stackdriver Monitoring V3 Client - Class MetricAbsence (1.11.0)

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

A condition type that checks that monitored resources are reporting data. The configuration defines a metric and a set of monitored resources. The predicate is considered in violation when a time series for the specified metric of a monitored resource does not include any data in the specified duration.

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

Namespace

Google \ Cloud \ Monitoring \ V3 \ AlertPolicy \ Condition

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.

↳ duration Google\Protobuf\Duration

The amount of time that a time series must fail to report new data to be considered failing. The minimum value of this field is 120 seconds. Larger values that are a multiple of a minute--for example, 240 or 300 seconds--are supported. If an invalid value is given, an error will be returned. The Duration.nanos field is ignored.

↳ 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.

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.

Returns
Type Description
string

setFilter

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.

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.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setAggregations

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.

Parameter
Name Description
var array<Google\Cloud\Monitoring\V3\Aggregation>
Returns
Type Description
$this

getDuration

The amount of time that a time series must fail to report new data to be considered failing. The minimum value of this field is 120 seconds. Larger values that are a multiple of a minute--for example, 240 or 300 seconds--are supported.

If an invalid value is given, an error will be returned. The Duration.nanos field is ignored.

Returns
Type Description
Google\Protobuf\Duration|null

hasDuration

clearDuration

setDuration

The amount of time that a time series must fail to report new data to be considered failing. The minimum value of this field is 120 seconds. Larger values that are a multiple of a minute--for example, 240 or 300 seconds--are supported.

If an invalid value is given, an error will be returned. The Duration.nanos field is ignored.

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.

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

hasTrigger

clearTrigger

setTrigger

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.

Parameter
Name Description
var Google\Cloud\Monitoring\V3\AlertPolicy\Condition\Trigger
Returns
Type Description
$this