Cloud Monitoring Dashboards V1 API - Class Google::Cloud::Monitoring::Dashboard::V1::TimeSeriesQuery (v1.1.0)

Reference documentation and code samples for the Cloud Monitoring Dashboards V1 API class Google::Cloud::Monitoring::Dashboard::V1::TimeSeriesQuery.

TimeSeriesQuery collects the set of supported methods for querying time series data from the Stackdriver metrics API.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#output_full_duration

def output_full_duration() -> ::Boolean
Returns
  • (::Boolean) —

    Optional. If set, Cloud Monitoring will treat the full query duration as the alignment period so that there will be only 1 output value.

    *Note: This could override the configured alignment period except for the cases where a series of data points are expected, like

    • XyChart
    • Scorecard's spark chart

#output_full_duration=

def output_full_duration=(value) -> ::Boolean
Parameter
  • value (::Boolean) —

    Optional. If set, Cloud Monitoring will treat the full query duration as the alignment period so that there will be only 1 output value.

    *Note: This could override the configured alignment period except for the cases where a series of data points are expected, like

    • XyChart
    • Scorecard's spark chart
Returns
  • (::Boolean) —

    Optional. If set, Cloud Monitoring will treat the full query duration as the alignment period so that there will be only 1 output value.

    *Note: This could override the configured alignment period except for the cases where a series of data points are expected, like

    • XyChart
    • Scorecard's spark chart

#prometheus_query

def prometheus_query() -> ::String
Returns
  • (::String) — A query used to fetch time series with PromQL.

#prometheus_query=

def prometheus_query=(value) -> ::String
Parameter
  • value (::String) — A query used to fetch time series with PromQL.
Returns
  • (::String) — A query used to fetch time series with PromQL.

#time_series_filter

def time_series_filter() -> ::Google::Cloud::Monitoring::Dashboard::V1::TimeSeriesFilter
Returns

#time_series_filter=

def time_series_filter=(value) -> ::Google::Cloud::Monitoring::Dashboard::V1::TimeSeriesFilter
Parameter
Returns

#time_series_filter_ratio

def time_series_filter_ratio() -> ::Google::Cloud::Monitoring::Dashboard::V1::TimeSeriesFilterRatio
Returns

#time_series_filter_ratio=

def time_series_filter_ratio=(value) -> ::Google::Cloud::Monitoring::Dashboard::V1::TimeSeriesFilterRatio
Parameter
Returns

#time_series_query_language

def time_series_query_language() -> ::String
Returns
  • (::String) — A query used to fetch time series with MQL.

#time_series_query_language=

def time_series_query_language=(value) -> ::String
Parameter
  • value (::String) — A query used to fetch time series with MQL.
Returns
  • (::String) — A query used to fetch time series with MQL.

#unit_override

def unit_override() -> ::String
Returns
  • (::String) — The unit of data contained in fetched time series. If non-empty, this unit will override any unit that accompanies fetched data. The format is the same as the unit field in MetricDescriptor.

#unit_override=

def unit_override=(value) -> ::String
Parameter
  • value (::String) — The unit of data contained in fetched time series. If non-empty, this unit will override any unit that accompanies fetched data. The format is the same as the unit field in MetricDescriptor.
Returns
  • (::String) — The unit of data contained in fetched time series. If non-empty, this unit will override any unit that accompanies fetched data. The format is the same as the unit field in MetricDescriptor.