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 |
↳ good_total_ratio_threshold |
Google\Cloud\Monitoring\V3\WindowsBasedSli\PerformanceThreshold
A window is good if its |
↳ 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 |
getGoodBadMetricFilter
A monitoring filter
specifying a TimeSeries with ValueType = BOOL. The window is good if
any true values appear in the window.
Generated from protobuf field string good_bad_metric_filter = 5;
| 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.
Generated from protobuf field string good_bad_metric_filter = 5;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getGoodTotalRatioThreshold
A window is good if its performance is high enough.
Generated from protobuf field .google.monitoring.v3.WindowsBasedSli.PerformanceThreshold good_total_ratio_threshold = 2;
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Monitoring\V3\WindowsBasedSli\PerformanceThreshold|null | |
hasGoodTotalRatioThreshold
setGoodTotalRatioThreshold
A window is good if its performance is high enough.
Generated from protobuf field .google.monitoring.v3.WindowsBasedSli.PerformanceThreshold good_total_ratio_threshold = 2;
| 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.
Generated from protobuf field .google.monitoring.v3.WindowsBasedSli.MetricRange metric_mean_in_range = 6;
| 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.
Generated from protobuf field .google.monitoring.v3.WindowsBasedSli.MetricRange metric_mean_in_range = 6;
| 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.
Generated from protobuf field .google.monitoring.v3.WindowsBasedSli.MetricRange metric_sum_in_range = 7;
| 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.
Generated from protobuf field .google.monitoring.v3.WindowsBasedSli.MetricRange metric_sum_in_range = 7;
| 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.
Generated from protobuf field .google.protobuf.Duration window_period = 4;
| 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.
Generated from protobuf field .google.protobuf.Duration window_period = 4;
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Duration
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getWindowCriterion
| Returns | |
|---|---|
| Type | Description |
string | |