Class: MuxRuby::MonitoringApi

Inherits:
Object
  • Object
show all
Defined in:
lib/mux_ruby/api/monitoring_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ MonitoringApi

Returns a new instance of MonitoringApi.



19
20
21
 
# File 'lib/mux_ruby/api/monitoring_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/mux_ruby/api/monitoring_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#get_monitoring_breakdown(monitoring_metric_id, opts = {}) ⇒ GetMonitoringBreakdownResponse

Get Monitoring Breakdown Gets breakdown information for a specific dimension and metric along with the number of concurrent viewers and negative impact score.

Parameters:

  • monitoring_metric_id (String) —

    ID of the Monitoring Metric

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :dimension (String) —

    Dimension the specified value belongs to

  • :timestamp (Integer) —

    Timestamp to limit results by. This value must be provided as a unix timestamp. Defaults to the current unix timestamp.

  • :filters (Array<String>) —

    Limit the results to rows that match conditions from provided key:value pairs. Must be provided as an array query string parameter. To exclude rows that match a certain condition, prepend a &#x60;!&#x60; character to the dimension. Possible filter names are the same as returned by the List Monitoring Dimensions endpoint. Example: * &#x60;filters[]&#x3D;operating_system:windows&amp;filters&#x3D;!country:US&#x60;

  • :order_by (String) —

    Value to order the results by

  • :order_direction (String) —

    Sort order.

Returns:



32
33
34
35
 
# File 'lib/mux_ruby/api/monitoring_api.rb', line 32

def get_monitoring_breakdown(monitoring_metric_id, opts = {})
  data, _status_code, _headers = get_monitoring_breakdown_with_http_info(monitoring_metric_id, opts)
  data
end

#get_monitoring_breakdown_timeseries(monitoring_metric_id, opts = {}) ⇒ GetMonitoringBreakdownTimeseriesResponse

Get Monitoring Breakdown Timeseries Gets timeseries of breakdown information for a specific dimension and metric. Each datapoint in the response represents 5 seconds worth of data.

Parameters:

  • monitoring_metric_id (String) —

    ID of the Monitoring Metric

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :dimension (String) —

    Dimension the specified value belongs to

  • :timeframe (Array<String>) —

    Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]&#x3D;). The default for this is the last 60 seconds of available data. Timeframes larger than 10 minutes are not allowed, and must be within the last 24 hours.

  • :filters (Array<String>) —

    Limit the results to rows that match conditions from provided key:value pairs. Must be provided as an array query string parameter. To exclude rows that match a certain condition, prepend a &#x60;!&#x60; character to the dimension. Possible filter names are the same as returned by the List Monitoring Dimensions endpoint. Example: * &#x60;filters[]&#x3D;operating_system:windows&amp;filters&#x3D;!country:US&#x60;

  • :limit (Integer) —

    Number of items to include in each timestamp&#39;s &#x60;value&#x60; list. The default is 10, and the maximum is 100. (default to 10)

  • :order_by (String) —

    Value to order the results by

  • :order_direction (String) —

    Sort order.

Returns:



128
129
130
131
 
# File 'lib/mux_ruby/api/monitoring_api.rb', line 128

def get_monitoring_breakdown_timeseries(monitoring_metric_id, opts = {})
  data, _status_code, _headers = get_monitoring_breakdown_timeseries_with_http_info(monitoring_metric_id, opts)
  data
end

#get_monitoring_breakdown_timeseries_with_http_info(monitoring_metric_id, opts = {}) ⇒ Array<(GetMonitoringBreakdownTimeseriesResponse, Integer, Hash)>

Get Monitoring Breakdown Timeseries Gets timeseries of breakdown information for a specific dimension and metric. Each datapoint in the response represents 5 seconds worth of data.

Parameters:

  • monitoring_metric_id (String) —

    ID of the Monitoring Metric

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :dimension (String) —

    Dimension the specified value belongs to

  • :timeframe (Array<String>) —

    Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]&#x3D;). The default for this is the last 60 seconds of available data. Timeframes larger than 10 minutes are not allowed, and must be within the last 24 hours.

  • :filters (Array<String>) —

    Limit the results to rows that match conditions from provided key:value pairs. Must be provided as an array query string parameter. To exclude rows that match a certain condition, prepend a &#x60;!&#x60; character to the dimension. Possible filter names are the same as returned by the List Monitoring Dimensions endpoint. Example: * &#x60;filters[]&#x3D;operating_system:windows&amp;filters&#x3D;!country:US&#x60;

  • :limit (Integer) —

    Number of items to include in each timestamp&#39;s &#x60;value&#x60; list. The default is 10, and the maximum is 100.

  • :order_by (String) —

    Value to order the results by

  • :order_direction (String) —

    Sort order.

Returns:



144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
 
# File 'lib/mux_ruby/api/monitoring_api.rb', line 144

def get_monitoring_breakdown_timeseries_with_http_info(monitoring_metric_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MonitoringApi.get_monitoring_breakdown_timeseries ...'
  end
  # verify the required parameter 'monitoring_metric_id' is set
  if @api_client.config.client_side_validation && monitoring_metric_id.nil?
    fail ArgumentError, "Missing the required parameter 'monitoring_metric_id' when calling MonitoringApi.get_monitoring_breakdown_timeseries"
  end
  # verify enum value
  allowable_values = ["current-concurrent-viewers", "current-rebuffering-percentage", "exits-before-video-start", "playback-failure-percentage", "current-average-bitrate", "video-startup-failure-percentage"]
  if @api_client.config.client_side_validation && !allowable_values.include?(monitoring_metric_id)
    fail ArgumentError, "invalid value for \"monitoring_metric_id\", must be one of #{allowable_values}"
  end
  allowable_values = ["asn", "cdn", "country", "operating_system", "player_name", "region", "stream_type", "sub_property_id", "video_series", "video_title", "view_has_ad"]
  if @api_client.config.client_side_validation && opts[:'dimension'] && !allowable_values.include?(opts[:'dimension'])
    fail ArgumentError, "invalid value for \"dimension\", must be one of #{allowable_values}"
  end
  allowable_values = ["negative_impact", "value", "views", "field"]
  if @api_client.config.client_side_validation && opts[:'order_by'] && !allowable_values.include?(opts[:'order_by'])
    fail ArgumentError, "invalid value for \"order_by\", must be one of #{allowable_values}"
  end
  allowable_values = ["asc", "desc"]
  if @api_client.config.client_side_validation && opts[:'order_direction'] && !allowable_values.include?(opts[:'order_direction'])
    fail ArgumentError, "invalid value for \"order_direction\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/data/v1/monitoring/metrics/{MONITORING_METRIC_ID}/breakdown-timeseries'.sub('{' + 'MONITORING_METRIC_ID' + '}', CGI.escape(monitoring_metric_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'dimension'] = opts[:'dimension'] if !opts[:'dimension'].nil?
  query_params[:'timeframe[]'] = @api_client.build_collection_param(opts[:'timeframe'], :multi) if !opts[:'timeframe'].nil?
  query_params[:'filters[]'] = @api_client.build_collection_param(opts[:'filters'], :multi) if !opts[:'filters'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'order_by'] = opts[:'order_by'] if !opts[:'order_by'].nil?
  query_params[:'order_direction'] = opts[:'order_direction'] if !opts[:'order_direction'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'GetMonitoringBreakdownTimeseriesResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['accessToken']

  new_options = opts.merge(
    :operation => :"MonitoringApi.get_monitoring_breakdown_timeseries",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MonitoringApi#get_monitoring_breakdown_timeseries\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_monitoring_breakdown_with_http_info(monitoring_metric_id, opts = {}) ⇒ Array<(GetMonitoringBreakdownResponse, Integer, Hash)>

Get Monitoring Breakdown Gets breakdown information for a specific dimension and metric along with the number of concurrent viewers and negative impact score.

Parameters:

  • monitoring_metric_id (String) —

    ID of the Monitoring Metric

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :dimension (String) —

    Dimension the specified value belongs to

  • :timestamp (Integer) —

    Timestamp to limit results by. This value must be provided as a unix timestamp. Defaults to the current unix timestamp.

  • :filters (Array<String>) —

    Limit the results to rows that match conditions from provided key:value pairs. Must be provided as an array query string parameter. To exclude rows that match a certain condition, prepend a &#x60;!&#x60; character to the dimension. Possible filter names are the same as returned by the List Monitoring Dimensions endpoint. Example: * &#x60;filters[]&#x3D;operating_system:windows&amp;filters&#x3D;!country:US&#x60;

  • :order_by (String) —

    Value to order the results by

  • :order_direction (String) —

    Sort order.

Returns:



47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/mux_ruby/api/monitoring_api.rb', line 47

def get_monitoring_breakdown_with_http_info(monitoring_metric_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MonitoringApi.get_monitoring_breakdown ...'
  end
  # verify the required parameter 'monitoring_metric_id' is set
  if @api_client.config.client_side_validation && monitoring_metric_id.nil?
    fail ArgumentError, "Missing the required parameter 'monitoring_metric_id' when calling MonitoringApi.get_monitoring_breakdown"
  end
  # verify enum value
  allowable_values = ["current-concurrent-viewers", "current-rebuffering-percentage", "exits-before-video-start", "playback-failure-percentage", "current-average-bitrate", "video-startup-failure-percentage"]
  if @api_client.config.client_side_validation && !allowable_values.include?(monitoring_metric_id)
    fail ArgumentError, "invalid value for \"monitoring_metric_id\", must be one of #{allowable_values}"
  end
  allowable_values = ["asn", "cdn", "country", "operating_system", "player_name", "region", "stream_type", "sub_property_id", "video_series", "video_title", "view_has_ad"]
  if @api_client.config.client_side_validation && opts[:'dimension'] && !allowable_values.include?(opts[:'dimension'])
    fail ArgumentError, "invalid value for \"dimension\", must be one of #{allowable_values}"
  end
  allowable_values = ["negative_impact", "value", "views", "field"]
  if @api_client.config.client_side_validation && opts[:'order_by'] && !allowable_values.include?(opts[:'order_by'])
    fail ArgumentError, "invalid value for \"order_by\", must be one of #{allowable_values}"
  end
  allowable_values = ["asc", "desc"]
  if @api_client.config.client_side_validation && opts[:'order_direction'] && !allowable_values.include?(opts[:'order_direction'])
    fail ArgumentError, "invalid value for \"order_direction\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/data/v1/monitoring/metrics/{MONITORING_METRIC_ID}/breakdown'.sub('{' + 'MONITORING_METRIC_ID' + '}', CGI.escape(monitoring_metric_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'dimension'] = opts[:'dimension'] if !opts[:'dimension'].nil?
  query_params[:'timestamp'] = opts[:'timestamp'] if !opts[:'timestamp'].nil?
  query_params[:'filters[]'] = @api_client.build_collection_param(opts[:'filters'], :multi) if !opts[:'filters'].nil?
  query_params[:'order_by'] = opts[:'order_by'] if !opts[:'order_by'].nil?
  query_params[:'order_direction'] = opts[:'order_direction'] if !opts[:'order_direction'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'GetMonitoringBreakdownResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['accessToken']

  new_options = opts.merge(
    :operation => :"MonitoringApi.get_monitoring_breakdown",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MonitoringApi#get_monitoring_breakdown\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_monitoring_histogram_timeseries(monitoring_histogram_metric_id, opts = {}) ⇒ GetMonitoringHistogramTimeseriesResponse

Get Monitoring Histogram Timeseries Gets histogram timeseries information for a specific metric.

Parameters:

  • monitoring_histogram_metric_id (String) —

    ID of the Monitoring Histogram Metric

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :filters (Array<String>) —

    Limit the results to rows that match conditions from provided key:value pairs. Must be provided as an array query string parameter. To exclude rows that match a certain condition, prepend a &#x60;!&#x60; character to the dimension. Possible filter names are the same as returned by the List Monitoring Dimensions endpoint. Example: * &#x60;filters[]&#x3D;operating_system:windows&amp;filters&#x3D;!country:US&#x60;

Returns:



221
222
223
224
 
# File 'lib/mux_ruby/api/monitoring_api.rb', line 221

def get_monitoring_histogram_timeseries(monitoring_histogram_metric_id, opts = {})
  data, _status_code, _headers = get_monitoring_histogram_timeseries_with_http_info(monitoring_histogram_metric_id, opts)
  data
end

#get_monitoring_histogram_timeseries_with_http_info(monitoring_histogram_metric_id, opts = {}) ⇒ Array<(GetMonitoringHistogramTimeseriesResponse, Integer, Hash)>

Get Monitoring Histogram Timeseries Gets histogram timeseries information for a specific metric.

Parameters:

  • monitoring_histogram_metric_id (String) —

    ID of the Monitoring Histogram Metric

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :filters (Array<String>) —

    Limit the results to rows that match conditions from provided key:value pairs. Must be provided as an array query string parameter. To exclude rows that match a certain condition, prepend a &#x60;!&#x60; character to the dimension. Possible filter names are the same as returned by the List Monitoring Dimensions endpoint. Example: * &#x60;filters[]&#x3D;operating_system:windows&amp;filters&#x3D;!country:US&#x60;

Returns:



232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
 
# File 'lib/mux_ruby/api/monitoring_api.rb', line 232

def get_monitoring_histogram_timeseries_with_http_info(monitoring_histogram_metric_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MonitoringApi.get_monitoring_histogram_timeseries ...'
  end
  # verify the required parameter 'monitoring_histogram_metric_id' is set
  if @api_client.config.client_side_validation && monitoring_histogram_metric_id.nil?
    fail ArgumentError, "Missing the required parameter 'monitoring_histogram_metric_id' when calling MonitoringApi.get_monitoring_histogram_timeseries"
  end
  # verify enum value
  allowable_values = ["video-startup-time"]
  if @api_client.config.client_side_validation && !allowable_values.include?(monitoring_histogram_metric_id)
    fail ArgumentError, "invalid value for \"monitoring_histogram_metric_id\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/data/v1/monitoring/metrics/{MONITORING_HISTOGRAM_METRIC_ID}/histogram-timeseries'.sub('{' + 'MONITORING_HISTOGRAM_METRIC_ID' + '}', CGI.escape(monitoring_histogram_metric_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'filters[]'] = @api_client.build_collection_param(opts[:'filters'], :multi) if !opts[:'filters'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'GetMonitoringHistogramTimeseriesResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['accessToken']

  new_options = opts.merge(
    :operation => :"MonitoringApi.get_monitoring_histogram_timeseries",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MonitoringApi#get_monitoring_histogram_timeseries\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_monitoring_timeseries(monitoring_metric_id, opts = {}) ⇒ GetMonitoringTimeseriesResponse

Get Monitoring Timeseries Gets Time series information for a specific metric along with the number of concurrent viewers.

Parameters:

  • monitoring_metric_id (String) —

    ID of the Monitoring Metric

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :filters (Array<String>) —

    Limit the results to rows that match conditions from provided key:value pairs. Must be provided as an array query string parameter. To exclude rows that match a certain condition, prepend a &#x60;!&#x60; character to the dimension. Possible filter names are the same as returned by the List Monitoring Dimensions endpoint. Example: * &#x60;filters[]&#x3D;operating_system:windows&amp;filters&#x3D;!country:US&#x60;

  • :timestamp (Integer) —

    Timestamp to use as the start of the timeseries data. This value must be provided as a unix timestamp. Defaults to 30 minutes ago.

Returns:



293
294
295
296
 
# File 'lib/mux_ruby/api/monitoring_api.rb', line 293

def get_monitoring_timeseries(monitoring_metric_id, opts = {})
  data, _status_code, _headers = get_monitoring_timeseries_with_http_info(monitoring_metric_id, opts)
  data
end

#get_monitoring_timeseries_with_http_info(monitoring_metric_id, opts = {}) ⇒ Array<(GetMonitoringTimeseriesResponse, Integer, Hash)>

Get Monitoring Timeseries Gets Time series information for a specific metric along with the number of concurrent viewers.

Parameters:

  • monitoring_metric_id (String) —

    ID of the Monitoring Metric

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :filters (Array<String>) —

    Limit the results to rows that match conditions from provided key:value pairs. Must be provided as an array query string parameter. To exclude rows that match a certain condition, prepend a &#x60;!&#x60; character to the dimension. Possible filter names are the same as returned by the List Monitoring Dimensions endpoint. Example: * &#x60;filters[]&#x3D;operating_system:windows&amp;filters&#x3D;!country:US&#x60;

  • :timestamp (Integer) —

    Timestamp to use as the start of the timeseries data. This value must be provided as a unix timestamp. Defaults to 30 minutes ago.

Returns:



305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
 
# File 'lib/mux_ruby/api/monitoring_api.rb', line 305

def get_monitoring_timeseries_with_http_info(monitoring_metric_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MonitoringApi.get_monitoring_timeseries ...'
  end
  # verify the required parameter 'monitoring_metric_id' is set
  if @api_client.config.client_side_validation && monitoring_metric_id.nil?
    fail ArgumentError, "Missing the required parameter 'monitoring_metric_id' when calling MonitoringApi.get_monitoring_timeseries"
  end
  # verify enum value
  allowable_values = ["current-concurrent-viewers", "current-rebuffering-percentage", "exits-before-video-start", "playback-failure-percentage", "current-average-bitrate", "video-startup-failure-percentage"]
  if @api_client.config.client_side_validation && !allowable_values.include?(monitoring_metric_id)
    fail ArgumentError, "invalid value for \"monitoring_metric_id\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/data/v1/monitoring/metrics/{MONITORING_METRIC_ID}/timeseries'.sub('{' + 'MONITORING_METRIC_ID' + '}', CGI.escape(monitoring_metric_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'filters[]'] = @api_client.build_collection_param(opts[:'filters'], :multi) if !opts[:'filters'].nil?
  query_params[:'timestamp'] = opts[:'timestamp'] if !opts[:'timestamp'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'GetMonitoringTimeseriesResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['accessToken']

  new_options = opts.merge(
    :operation => :"MonitoringApi.get_monitoring_timeseries",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MonitoringApi#get_monitoring_timeseries\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_monitoring_dimensions(opts = {}) ⇒ ListMonitoringDimensionsResponse

List Monitoring Dimensions Lists available monitoring dimensions.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



364
365
366
367
 
# File 'lib/mux_ruby/api/monitoring_api.rb', line 364

def list_monitoring_dimensions(opts = {})
  data, _status_code, _headers = list_monitoring_dimensions_with_http_info(opts)
  data
end

#list_monitoring_dimensions_with_http_info(opts = {}) ⇒ Array<(ListMonitoringDimensionsResponse, Integer, Hash)>

List Monitoring Dimensions Lists available monitoring dimensions.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
 
# File 'lib/mux_ruby/api/monitoring_api.rb', line 373

def list_monitoring_dimensions_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MonitoringApi.list_monitoring_dimensions ...'
  end
  # resource path
  local_var_path = '/data/v1/monitoring/dimensions'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'ListMonitoringDimensionsResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['accessToken']

  new_options = opts.merge(
    :operation => :"MonitoringApi.list_monitoring_dimensions",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MonitoringApi#list_monitoring_dimensions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_monitoring_metrics(opts = {}) ⇒ ListMonitoringMetricsResponse

List Monitoring Metrics Lists available monitoring metrics.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



421
422
423
424
 
# File 'lib/mux_ruby/api/monitoring_api.rb', line 421

def list_monitoring_metrics(opts = {})
  data, _status_code, _headers = list_monitoring_metrics_with_http_info(opts)
  data
end

#list_monitoring_metrics_with_http_info(opts = {}) ⇒ Array<(ListMonitoringMetricsResponse, Integer, Hash)>

List Monitoring Metrics Lists available monitoring metrics.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
 
# File 'lib/mux_ruby/api/monitoring_api.rb', line 430

def list_monitoring_metrics_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MonitoringApi.list_monitoring_metrics ...'
  end
  # resource path
  local_var_path = '/data/v1/monitoring/metrics'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'ListMonitoringMetricsResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['accessToken']

  new_options = opts.merge(
    :operation => :"MonitoringApi.list_monitoring_metrics",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MonitoringApi#list_monitoring_metrics\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end