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.



1869
1870
1871
 
# File 'lib/google/apis/monitoring_v1/classes.rb', line 1869

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) 


1837
1838
1839
 
# File 'lib/google/apis/monitoring_v1/classes.rb', line 1837

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) 


1843
1844
1845
 
# File 'lib/google/apis/monitoring_v1/classes.rb', line 1843

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) 


1849
1850
1851
 
# File 'lib/google/apis/monitoring_v1/classes.rb', line 1849

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) 


1858
1859
1860
 
# File 'lib/google/apis/monitoring_v1/classes.rb', line 1858

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) 


1867
1868
1869
 
# File 'lib/google/apis/monitoring_v1/classes.rb', line 1867

def timeout
  @timeout
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1874
1875
1876
1877
1878
1879
1880
 
# File 'lib/google/apis/monitoring_v1/classes.rb', line 1874

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