Class: MuxRuby::RealTimeApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ RealTimeApi

Returns a new instance of RealTimeApi.



19
20
21
 
# File 'lib/mux_ruby/api/real_time_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/real_time_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#get_realtime_breakdown(realtime_metric_id, opts = {}) ⇒ GetRealTimeBreakdownResponse

Get Real-Time Breakdown Gets breakdown information for a specific dimension and metric along with the number of concurrent viewers and negative impact score. This API is now deprecated, please use the ‘Get Monitoring Breakdown` API.

Parameters:

  • realtime_metric_id (String) —

    ID of the Realtime 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/real_time_api.rb', line 32

def get_realtime_breakdown(realtime_metric_id, opts = {})
  data, _status_code, _headers = get_realtime_breakdown_with_http_info(realtime_metric_id, opts)
  data
end

#get_realtime_breakdown_with_http_info(realtime_metric_id, opts = {}) ⇒ Array<(GetRealTimeBreakdownResponse, Integer, Hash)>

Get Real-Time Breakdown Gets breakdown information for a specific dimension and metric along with the number of concurrent viewers and negative impact score. This API is now deprecated, please use the &#x60;Get Monitoring Breakdown&#x60; API.

Parameters:

  • realtime_metric_id (String) —

    ID of the Realtime 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/real_time_api.rb', line 47

def get_realtime_breakdown_with_http_info(realtime_metric_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RealTimeApi.get_realtime_breakdown ...'
  end
  # verify the required parameter 'realtime_metric_id' is set
  if @api_client.config.client_side_validation && realtime_metric_id.nil?
    fail ArgumentError, "Missing the required parameter 'realtime_metric_id' when calling RealTimeApi.get_realtime_breakdown"
  end
  # verify enum value
  allowable_values = ["current-concurrent-viewers", "current-rebuffering-percentage", "exits-before-video-start", "playback-failure-percentage", "current-average-bitrate"]
  if @api_client.config.client_side_validation && !allowable_values.include?(realtime_metric_id)
    fail ArgumentError, "invalid value for \"realtime_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"]
  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/realtime/metrics/{REALTIME_METRIC_ID}/breakdown'.sub('{' + 'REALTIME_METRIC_ID' + '}', CGI.escape(realtime_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] || 'GetRealTimeBreakdownResponse'

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

  new_options = opts.merge(
    :operation => :"RealTimeApi.get_realtime_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: RealTimeApi#get_realtime_breakdown\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_realtime_histogram_timeseries(realtime_histogram_metric_id, opts = {}) ⇒ GetRealTimeHistogramTimeseriesResponse

Get Real-Time Histogram Timeseries Gets histogram timeseries information for a specific metric. This API is now deprecated, please use the ‘Get Monitoring Histogram Timeseries` API.

Parameters:

  • realtime_histogram_metric_id (String) —

    ID of the Realtime 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:



123
124
125
126
 
# File 'lib/mux_ruby/api/real_time_api.rb', line 123

def get_realtime_histogram_timeseries(realtime_histogram_metric_id, opts = {})
  data, _status_code, _headers = get_realtime_histogram_timeseries_with_http_info(realtime_histogram_metric_id, opts)
  data
end

#get_realtime_histogram_timeseries_with_http_info(realtime_histogram_metric_id, opts = {}) ⇒ Array<(GetRealTimeHistogramTimeseriesResponse, Integer, Hash)>

Get Real-Time Histogram Timeseries Gets histogram timeseries information for a specific metric. This API is now deprecated, please use the &#x60;Get Monitoring Histogram Timeseries&#x60; API.

Parameters:

  • realtime_histogram_metric_id (String) —

    ID of the Realtime 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:



134
135
136
137
138
139
140
141
142
143
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
 
# File 'lib/mux_ruby/api/real_time_api.rb', line 134

def get_realtime_histogram_timeseries_with_http_info(realtime_histogram_metric_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RealTimeApi.get_realtime_histogram_timeseries ...'
  end
  # verify the required parameter 'realtime_histogram_metric_id' is set
  if @api_client.config.client_side_validation && realtime_histogram_metric_id.nil?
    fail ArgumentError, "Missing the required parameter 'realtime_histogram_metric_id' when calling RealTimeApi.get_realtime_histogram_timeseries"
  end
  # verify enum value
  allowable_values = ["video-startup-time"]
  if @api_client.config.client_side_validation && !allowable_values.include?(realtime_histogram_metric_id)
    fail ArgumentError, "invalid value for \"realtime_histogram_metric_id\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/data/v1/realtime/metrics/{REALTIME_HISTOGRAM_METRIC_ID}/histogram-timeseries'.sub('{' + 'REALTIME_HISTOGRAM_METRIC_ID' + '}', CGI.escape(realtime_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] || 'GetRealTimeHistogramTimeseriesResponse'

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

  new_options = opts.merge(
    :operation => :"RealTimeApi.get_realtime_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: RealTimeApi#get_realtime_histogram_timeseries\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_realtime_timeseries(realtime_metric_id, opts = {}) ⇒ GetRealTimeTimeseriesResponse

Get Real-Time Timeseries Gets Time series information for a specific metric along with the number of concurrent viewers. This API is now deprecated, please use the ‘Get Monitoring Timeseries` API.

Parameters:

  • realtime_metric_id (String) —

    ID of the Realtime 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:



195
196
197
198
 
# File 'lib/mux_ruby/api/real_time_api.rb', line 195

def get_realtime_timeseries(realtime_metric_id, opts = {})
  data, _status_code, _headers = get_realtime_timeseries_with_http_info(realtime_metric_id, opts)
  data
end

#get_realtime_timeseries_with_http_info(realtime_metric_id, opts = {}) ⇒ Array<(GetRealTimeTimeseriesResponse, Integer, Hash)>

Get Real-Time Timeseries Gets Time series information for a specific metric along with the number of concurrent viewers. This API is now deprecated, please use the &#x60;Get Monitoring Timeseries&#x60; API.

Parameters:

  • realtime_metric_id (String) —

    ID of the Realtime 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:



207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
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
 
# File 'lib/mux_ruby/api/real_time_api.rb', line 207

def get_realtime_timeseries_with_http_info(realtime_metric_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RealTimeApi.get_realtime_timeseries ...'
  end
  # verify the required parameter 'realtime_metric_id' is set
  if @api_client.config.client_side_validation && realtime_metric_id.nil?
    fail ArgumentError, "Missing the required parameter 'realtime_metric_id' when calling RealTimeApi.get_realtime_timeseries"
  end
  # verify enum value
  allowable_values = ["current-concurrent-viewers", "current-rebuffering-percentage", "exits-before-video-start", "playback-failure-percentage", "current-average-bitrate"]
  if @api_client.config.client_side_validation && !allowable_values.include?(realtime_metric_id)
    fail ArgumentError, "invalid value for \"realtime_metric_id\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/data/v1/realtime/metrics/{REALTIME_METRIC_ID}/timeseries'.sub('{' + 'REALTIME_METRIC_ID' + '}', CGI.escape(realtime_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] || 'GetRealTimeTimeseriesResponse'

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

  new_options = opts.merge(
    :operation => :"RealTimeApi.get_realtime_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: RealTimeApi#get_realtime_timeseries\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_realtime_dimensions(opts = {}) ⇒ ListRealTimeDimensionsResponse

List Real-Time Dimensions Lists available real-time dimensions. This API is now deprecated, please use the ‘List Monitoring Dimensions` API.

Parameters:

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

    the optional parameters

Returns:



266
267
268
269
 
# File 'lib/mux_ruby/api/real_time_api.rb', line 266

def list_realtime_dimensions(opts = {})
  data, _status_code, _headers = list_realtime_dimensions_with_http_info(opts)
  data
end

#list_realtime_dimensions_with_http_info(opts = {}) ⇒ Array<(ListRealTimeDimensionsResponse, Integer, Hash)>

List Real-Time Dimensions Lists available real-time dimensions. This API is now deprecated, please use the &#x60;List Monitoring Dimensions&#x60; API.

Parameters:

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

    the optional parameters

Returns:



275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
 
# File 'lib/mux_ruby/api/real_time_api.rb', line 275

def list_realtime_dimensions_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RealTimeApi.list_realtime_dimensions ...'
  end
  # resource path
  local_var_path = '/data/v1/realtime/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] || 'ListRealTimeDimensionsResponse'

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

  new_options = opts.merge(
    :operation => :"RealTimeApi.list_realtime_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: RealTimeApi#list_realtime_dimensions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_realtime_metrics(opts = {}) ⇒ ListRealTimeMetricsResponse

List Real-Time Metrics Lists available real-time metrics. This API is now deprecated, please use the ‘List Monitoring Metrics` API.

Parameters:

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

    the optional parameters

Returns:



323
324
325
326
 
# File 'lib/mux_ruby/api/real_time_api.rb', line 323

def list_realtime_metrics(opts = {})
  data, _status_code, _headers = list_realtime_metrics_with_http_info(opts)
  data
end

#list_realtime_metrics_with_http_info(opts = {}) ⇒ Array<(ListRealTimeMetricsResponse, Integer, Hash)>

List Real-Time Metrics Lists available real-time metrics. This API is now deprecated, please use the &#x60;List Monitoring Metrics&#x60; API.

Parameters:

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

    the optional parameters

Returns:

  • (Array<(ListRealTimeMetricsResponse, Integer, Hash)>) —

    ListRealTimeMetricsResponse data, response status code and response headers



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
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
 
# File 'lib/mux_ruby/api/real_time_api.rb', line 332

def list_realtime_metrics_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RealTimeApi.list_realtime_metrics ...'
  end
  # resource path
  local_var_path = '/data/v1/realtime/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] || 'ListRealTimeMetricsResponse'

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

  new_options = opts.merge(
    :operation => :"RealTimeApi.list_realtime_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: RealTimeApi#list_realtime_metrics\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end