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.



1228
1229
1230
 
# File 'lib/google/apis/monitoring_v1/classes.rb', line 1228

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) 


1196
1197
1198
 
# File 'lib/google/apis/monitoring_v1/classes.rb', line 1196

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) 


1202
1203
1204
 
# File 'lib/google/apis/monitoring_v1/classes.rb', line 1202

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) 


1208
1209
1210
 
# File 'lib/google/apis/monitoring_v1/classes.rb', line 1208

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) 


1217
1218
1219
 
# File 'lib/google/apis/monitoring_v1/classes.rb', line 1217

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) 


1226
1227
1228
 
# File 'lib/google/apis/monitoring_v1/classes.rb', line 1226

def timeout
  @timeout
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1233
1234
1235
1236
1237
1238
1239
 
# File 'lib/google/apis/monitoring_v1/classes.rb', line 1233

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