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.



1735
1736
1737
 
# File 'lib/google/apis/monitoring_v1/classes.rb', line 1735

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) 


1703
1704
1705
 
# File 'lib/google/apis/monitoring_v1/classes.rb', line 1703

def end
  @end
end

#query ⇒ String

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

Returns:

  • (String) 


1709
1710
1711
 
# File 'lib/google/apis/monitoring_v1/classes.rb', line 1709

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) 


1715
1716
1717
 
# File 'lib/google/apis/monitoring_v1/classes.rb', line 1715

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) 


1724
1725
1726
 
# File 'lib/google/apis/monitoring_v1/classes.rb', line 1724

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) 


1733
1734
1735
 
# File 'lib/google/apis/monitoring_v1/classes.rb', line 1733

def timeout
  @timeout
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1740
1741
1742
1743
1744
1745
1746
 
# File 'lib/google/apis/monitoring_v1/classes.rb', line 1740

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