Stackdriver Monitoring V3 Client - Class WindowsBasedSli (1.4.0)

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

A WindowsBasedSli defines good_service as the count of time windows for which the provided service was of good quality. Criteria for determining if service was good are embedded in the window_criterion.

Generated from protobuf message google.monitoring.v3.WindowsBasedSli

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ good_bad_metric_filter`	`string` A monitoring filter specifying a `TimeSeries` with `ValueType = BOOL`. The window is good if any `true` values appear in the window.
`↳ good_total_ratio_threshold`	`Google\Cloud\Monitoring\V3\WindowsBasedSli\PerformanceThreshold` A window is good if its `performance` is high enough.
`↳ metric_mean_in_range`	`Google\Cloud\Monitoring\V3\WindowsBasedSli\MetricRange` A window is good if the metric's value is in a good range, averaged across returned streams.
`↳ metric_sum_in_range`	`Google\Cloud\Monitoring\V3\WindowsBasedSli\MetricRange` A window is good if the metric's value is in a good range, summed across returned streams.
`↳ window_period`	`Google\Protobuf\Duration` Duration over which window quality is evaluated. Must be an integer fraction of a day and at least `60s`.

getGoodBadMetricFilter

A monitoring filter specifying a TimeSeries with ValueType = BOOL. The window is good if any true values appear in the window.

Returns
Type	Description
`string`

hasGoodBadMetricFilter

setGoodBadMetricFilter

A monitoring filter specifying a TimeSeries with ValueType = BOOL. The window is good if any true values appear in the window.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getGoodTotalRatioThreshold

A window is good if its performance is high enough.

Returns
Type	Description
`Google\Cloud\Monitoring\V3\WindowsBasedSli\PerformanceThreshold\|null`

hasGoodTotalRatioThreshold

setGoodTotalRatioThreshold

A window is good if its performance is high enough.

Parameter
Name	Description
`var`	`Google\Cloud\Monitoring\V3\WindowsBasedSli\PerformanceThreshold`

Returns
Type	Description
`$this`

getMetricMeanInRange

A window is good if the metric's value is in a good range, averaged across returned streams.

Returns
Type	Description
`Google\Cloud\Monitoring\V3\WindowsBasedSli\MetricRange\|null`

hasMetricMeanInRange

setMetricMeanInRange

A window is good if the metric's value is in a good range, averaged across returned streams.

Parameter
Name	Description
`var`	`Google\Cloud\Monitoring\V3\WindowsBasedSli\MetricRange`

Returns
Type	Description
`$this`

getMetricSumInRange

A window is good if the metric's value is in a good range, summed across returned streams.

Returns
Type	Description
`Google\Cloud\Monitoring\V3\WindowsBasedSli\MetricRange\|null`

hasMetricSumInRange

setMetricSumInRange

A window is good if the metric's value is in a good range, summed across returned streams.

Parameter
Name	Description
`var`	`Google\Cloud\Monitoring\V3\WindowsBasedSli\MetricRange`

Returns
Type	Description
`$this`

getWindowPeriod

Duration over which window quality is evaluated. Must be an integer fraction of a day and at least 60s.

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

hasWindowPeriod

clearWindowPeriod

setWindowPeriod

Duration over which window quality is evaluated. Must be an integer fraction of a day and at least 60s.

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

Returns
Type	Description
`$this`

getWindowCriterion

Returns
Type	Description
`string`