Class: Google::Apis::MonitoringV1::QueryRangeRequest

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

QueryRangeRequest holds all parameters of the Prometheus upstream range query API plus GCM specific parameters.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ QueryRangeRequest

Returns a new instance of QueryRangeRequest.



1816
1817
1818
 
# File 'lib/google/apis/monitoring_v1/classes.rb', line 1816

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

Instance Attribute Details

#end ⇒ String

The end time to evaluate the query for. Either floating point UNIX seconds or RFC3339 formatted timestamp. Corresponds to the JSON property end

Returns:

  • (String) 


1784
1785
1786
 
# File 'lib/google/apis/monitoring_v1/classes.rb', line 1784

def end
  @end
end

#query ⇒ String

A PromQL query string. Query language documentation: https://prometheus.io/ docs/prometheus/latest/querying/basics/. Corresponds to the JSON property query

Returns:

  • (String) 


1790
1791
1792
 
# File 'lib/google/apis/monitoring_v1/classes.rb', line 1790

def query
  @query
end

#start ⇒ String

The start time to evaluate the query for. Either floating point UNIX seconds or RFC3339 formatted timestamp. Corresponds to the JSON property start

Returns:

  • (String) 


1796
1797
1798
 
# File 'lib/google/apis/monitoring_v1/classes.rb', line 1796

def start
  @start
end

#step ⇒ String

The resolution of query result. Either a Prometheus duration string (https:// prometheus.io/docs/prometheus/latest/querying/basics/#time-durations) or floating point seconds. This non-standard encoding must be used for compatibility with the open source API. Clients may still implement timeouts at the connection level while ignoring this field. Corresponds to the JSON property step

Returns:

  • (String) 


1805
1806
1807
 
# File 'lib/google/apis/monitoring_v1/classes.rb', line 1805

def step
  @step
end

#timeout ⇒ String

An upper bound timeout for the query. Either a Prometheus duration string ( https://prometheus.io/docs/prometheus/latest/querying/basics/#time-durations) or floating point seconds. This non-standard encoding must be used for compatibility with the open source API. Clients may still implement timeouts at the connection level while ignoring this field. Corresponds to the JSON property timeout

Returns:

  • (String) 


1814
1815
1816
 
# File 'lib/google/apis/monitoring_v1/classes.rb', line 1814

def timeout
  @timeout
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1821
1822
1823
1824
1825
1826
1827
 
# File 'lib/google/apis/monitoring_v1/classes.rb', line 1821

def update!(**args)
  @end = args[:end] if args.key?(:end)
  @query = args[:query] if args.key?(:query)
  @start = args[:start] if args.key?(:start)
  @step = args[:step] if args.key?(:step)
  @timeout = args[:timeout] if args.key?(:timeout)
end