Class: Google::Apis::MonitoringV1::DataSet

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/monitoring_v1/classes.rb,
generated/google/apis/monitoring_v1/representations.rb,
generated/google/apis/monitoring_v1/representations.rb

Overview

Groups a time series query definition with charting options.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ DataSet

Returns a new instance of DataSet.


300
301
302
# File 'generated/google/apis/monitoring_v1/classes.rb', line 300

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

Instance Attribute Details

#legend_templateString

A template string for naming TimeSeries in the resulting data set. This should be a string with interpolations of the form $label_name, which will resolve to the label's value. Corresponds to the JSON property legendTemplate

Returns:

  • (String)

278
279
280
# File 'generated/google/apis/monitoring_v1/classes.rb', line 278

def legend_template
  @legend_template
end

#min_alignment_periodString

Optional. The lower bound on data point frequency for this data set, implemented by specifying the minimum alignment period to use in a time series query For example, if the data is published once every 10 minutes, the min_alignment_period should be at least 10 minutes. It would not make sense to fetch and align data at one minute intervals. Corresponds to the JSON property minAlignmentPeriod

Returns:

  • (String)

287
288
289
# File 'generated/google/apis/monitoring_v1/classes.rb', line 287

def min_alignment_period
  @min_alignment_period
end

#plot_typeString

How this data should be plotted on the chart. Corresponds to the JSON property plotType

Returns:

  • (String)

292
293
294
# File 'generated/google/apis/monitoring_v1/classes.rb', line 292

def plot_type
  @plot_type
end

#time_series_queryGoogle::Apis::MonitoringV1::TimeSeriesQuery

TimeSeriesQuery collects the set of supported methods for querying time series data from the Stackdriver metrics API. Corresponds to the JSON property timeSeriesQuery


298
299
300
# File 'generated/google/apis/monitoring_v1/classes.rb', line 298

def time_series_query
  @time_series_query
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


305
306
307
308
309
310
# File 'generated/google/apis/monitoring_v1/classes.rb', line 305

def update!(**args)
  @legend_template = args[:legend_template] if args.key?(:legend_template)
  @min_alignment_period = args[:min_alignment_period] if args.key?(:min_alignment_period)
  @plot_type = args[:plot_type] if args.key?(:plot_type)
  @time_series_query = args[:time_series_query] if args.key?(:time_series_query)
end