Cloud Monitoring V3 API - Class Google::Cloud::Monitoring::V3::WindowsBasedSli (v1.7.0)

Reference documentation and code samples for the Cloud Monitoring V3 API class Google::Cloud::Monitoring::V3::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.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#good_bad_metric_filter

def good_bad_metric_filter() -> ::String
Returns
  • (::String) — A monitoring filter specifying a TimeSeries with ValueType = BOOL. The window is good if any true values appear in the window.

    Note: The following fields are mutually exclusive: good_bad_metric_filter, good_total_ratio_threshold, metric_mean_in_range, metric_sum_in_range. If a field in that set is populated, all other fields in the set will automatically be cleared.

#good_bad_metric_filter=

def good_bad_metric_filter=(value) -> ::String
Parameter
  • value (::String) — A monitoring filter specifying a TimeSeries with ValueType = BOOL. The window is good if any true values appear in the window.

    Note: The following fields are mutually exclusive: good_bad_metric_filter, good_total_ratio_threshold, metric_mean_in_range, metric_sum_in_range. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::String) — A monitoring filter specifying a TimeSeries with ValueType = BOOL. The window is good if any true values appear in the window.

    Note: The following fields are mutually exclusive: good_bad_metric_filter, good_total_ratio_threshold, metric_mean_in_range, metric_sum_in_range. If a field in that set is populated, all other fields in the set will automatically be cleared.

#good_total_ratio_threshold

def good_total_ratio_threshold() -> ::Google::Cloud::Monitoring::V3::WindowsBasedSli::PerformanceThreshold
Returns
  • (::Google::Cloud::Monitoring::V3::WindowsBasedSli::PerformanceThreshold) — A window is good if its performance is high enough.

    Note: The following fields are mutually exclusive: good_total_ratio_threshold, good_bad_metric_filter, metric_mean_in_range, metric_sum_in_range. If a field in that set is populated, all other fields in the set will automatically be cleared.

#good_total_ratio_threshold=

def good_total_ratio_threshold=(value) -> ::Google::Cloud::Monitoring::V3::WindowsBasedSli::PerformanceThreshold
Parameter
  • value (::Google::Cloud::Monitoring::V3::WindowsBasedSli::PerformanceThreshold) — A window is good if its performance is high enough.

    Note: The following fields are mutually exclusive: good_total_ratio_threshold, good_bad_metric_filter, metric_mean_in_range, metric_sum_in_range. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Cloud::Monitoring::V3::WindowsBasedSli::PerformanceThreshold) — A window is good if its performance is high enough.

    Note: The following fields are mutually exclusive: good_total_ratio_threshold, good_bad_metric_filter, metric_mean_in_range, metric_sum_in_range. If a field in that set is populated, all other fields in the set will automatically be cleared.

#metric_mean_in_range

def metric_mean_in_range() -> ::Google::Cloud::Monitoring::V3::WindowsBasedSli::MetricRange
Returns
  • (::Google::Cloud::Monitoring::V3::WindowsBasedSli::MetricRange) — A window is good if the metric's value is in a good range, averaged across returned streams.

    Note: The following fields are mutually exclusive: metric_mean_in_range, good_bad_metric_filter, good_total_ratio_threshold, metric_sum_in_range. If a field in that set is populated, all other fields in the set will automatically be cleared.

#metric_mean_in_range=

def metric_mean_in_range=(value) -> ::Google::Cloud::Monitoring::V3::WindowsBasedSli::MetricRange
Parameter
  • value (::Google::Cloud::Monitoring::V3::WindowsBasedSli::MetricRange) — A window is good if the metric's value is in a good range, averaged across returned streams.

    Note: The following fields are mutually exclusive: metric_mean_in_range, good_bad_metric_filter, good_total_ratio_threshold, metric_sum_in_range. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Cloud::Monitoring::V3::WindowsBasedSli::MetricRange) — A window is good if the metric's value is in a good range, averaged across returned streams.

    Note: The following fields are mutually exclusive: metric_mean_in_range, good_bad_metric_filter, good_total_ratio_threshold, metric_sum_in_range. If a field in that set is populated, all other fields in the set will automatically be cleared.

#metric_sum_in_range

def metric_sum_in_range() -> ::Google::Cloud::Monitoring::V3::WindowsBasedSli::MetricRange
Returns
  • (::Google::Cloud::Monitoring::V3::WindowsBasedSli::MetricRange) — A window is good if the metric's value is in a good range, summed across returned streams.

    Note: The following fields are mutually exclusive: metric_sum_in_range, good_bad_metric_filter, good_total_ratio_threshold, metric_mean_in_range. If a field in that set is populated, all other fields in the set will automatically be cleared.

#metric_sum_in_range=

def metric_sum_in_range=(value) -> ::Google::Cloud::Monitoring::V3::WindowsBasedSli::MetricRange
Parameter
  • value (::Google::Cloud::Monitoring::V3::WindowsBasedSli::MetricRange) — A window is good if the metric's value is in a good range, summed across returned streams.

    Note: The following fields are mutually exclusive: metric_sum_in_range, good_bad_metric_filter, good_total_ratio_threshold, metric_mean_in_range. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Cloud::Monitoring::V3::WindowsBasedSli::MetricRange) — A window is good if the metric's value is in a good range, summed across returned streams.

    Note: The following fields are mutually exclusive: metric_sum_in_range, good_bad_metric_filter, good_total_ratio_threshold, metric_mean_in_range. If a field in that set is populated, all other fields in the set will automatically be cleared.

#window_period

def window_period() -> ::Google::Protobuf::Duration
Returns
  • (::Google::Protobuf::Duration) — Duration over which window quality is evaluated. Must be an integer fraction of a day and at least 60s.

#window_period=

def window_period=(value) -> ::Google::Protobuf::Duration
Parameter
  • value (::Google::Protobuf::Duration) — Duration over which window quality is evaluated. Must be an integer fraction of a day and at least 60s.
Returns
  • (::Google::Protobuf::Duration) — Duration over which window quality is evaluated. Must be an integer fraction of a day and at least 60s.