Class: Google::Apis::MonitoringV1::TimeSeriesQuery

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/monitoring_v1/classes.rb,
lib/google/apis/monitoring_v1/representations.rb,
lib/google/apis/monitoring_v1/representations.rb

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ TimeSeriesQuery

Returns a new instance of TimeSeriesQuery.



2030
2031
2032
 
# File 'lib/google/apis/monitoring_v1/classes.rb', line 2030

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#output_full_duration ⇒ Boolean Also known as: output_full_duration?

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 Corresponds to the JSON property outputFullDuration

Returns:

  • (Boolean) 


1995
1996
1997
 
# File 'lib/google/apis/monitoring_v1/classes.rb', line 1995

def output_full_duration
  @output_full_duration
end

#prometheus_query ⇒ String

A query used to fetch time series with PromQL. Corresponds to the JSON property prometheusQuery

Returns:

  • (String) 


2001
2002
2003
 
# File 'lib/google/apis/monitoring_v1/classes.rb', line 2001

def prometheus_query
  @prometheus_query
end

#time_series_filter ⇒ Google::Apis::MonitoringV1::TimeSeriesFilter

A filter that defines a subset of time series data that is displayed in a widget. Time series data is fetched using the ListTimeSeries (https://cloud. google.com/monitoring/api/ref_v3/rest/v3/projects.timeSeries/list) method. Corresponds to the JSON property timeSeriesFilter

Returns:



2008
2009
2010
 
# File 'lib/google/apis/monitoring_v1/classes.rb', line 2008

def time_series_filter
  @time_series_filter
end

#time_series_filter_ratio ⇒ Google::Apis::MonitoringV1::TimeSeriesFilterRatio

A pair of time series filters that define a ratio computation. The output time series is the pair-wise division of each aligned element from the numerator and denominator time series. Corresponds to the JSON property timeSeriesFilterRatio

Returns:



2015
2016
2017
 
# File 'lib/google/apis/monitoring_v1/classes.rb', line 2015

def time_series_filter_ratio
  @time_series_filter_ratio
end

#time_series_query_language ⇒ String

A query used to fetch time series with MQL. Corresponds to the JSON property timeSeriesQueryLanguage

Returns:

  • (String) 


2020
2021
2022
 
# File 'lib/google/apis/monitoring_v1/classes.rb', line 2020

def time_series_query_language
  @time_series_query_language
end

#unit_override ⇒ 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 (https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects. metricDescriptors) field in MetricDescriptor. Corresponds to the JSON property unitOverride

Returns:

  • (String) 


2028
2029
2030
 
# File 'lib/google/apis/monitoring_v1/classes.rb', line 2028

def unit_override
  @unit_override
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2035
2036
2037
2038
2039
2040
2041
2042
 
# File 'lib/google/apis/monitoring_v1/classes.rb', line 2035

def update!(**args)
  @output_full_duration = args[:output_full_duration] if args.key?(:output_full_duration)
  @prometheus_query = args[:prometheus_query] if args.key?(:prometheus_query)
  @time_series_filter = args[:time_series_filter] if args.key?(:time_series_filter)
  @time_series_filter_ratio = args[:time_series_filter_ratio] if args.key?(:time_series_filter_ratio)
  @time_series_query_language = args[:time_series_query_language] if args.key?(:time_series_query_language)
  @unit_override = args[:unit_override] if args.key?(:unit_override)
end