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.



1596
1597
1598
 
# File 'lib/google/apis/monitoring_v1/classes.rb', line 1596

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) 


1564
1565
1566
 
# File 'lib/google/apis/monitoring_v1/classes.rb', line 1564

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) 


1570
1571
1572
 
# File 'lib/google/apis/monitoring_v1/classes.rb', line 1570

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) 


1576
1577
1578
 
# File 'lib/google/apis/monitoring_v1/classes.rb', line 1576

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) 


1585
1586
1587
 
# File 'lib/google/apis/monitoring_v1/classes.rb', line 1585

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) 


1594
1595
1596
 
# File 'lib/google/apis/monitoring_v1/classes.rb', line 1594

def timeout
  @timeout
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1601
1602
1603
1604
1605
1606
1607
 
# File 'lib/google/apis/monitoring_v1/classes.rb', line 1601

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