mux_ruby 3.8.0 → 3.11.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CODEOWNERS +1 -1
- data/Gemfile.lock +2 -2
- data/README.md +4 -4
- data/docs/Asset.md +7 -1
- data/docs/AssetGeneratedSubtitleSettings.md +22 -0
- data/docs/AssetNonStandardInputReasons.md +3 -1
- data/docs/AssetsApi.md +1 -1
- data/docs/CreateAssetRequest.md +5 -1
- data/docs/CreateLiveStreamRequest.md +3 -3
- data/docs/CreateTrackRequest.md +2 -2
- data/docs/DeliveryReport.md +5 -1
- data/docs/DeliveryReportDeliveredSecondsByResolution.md +26 -0
- data/docs/DirectUploadsApi.md +1 -1
- data/docs/GetMonitoringBreakdownTimeseriesResponse.md +22 -0
- data/docs/InputSettings.md +7 -5
- data/docs/LiveStream.md +4 -4
- data/docs/MetricsApi.md +2 -2
- data/docs/MonitoringApi.md +93 -6
- data/docs/MonitoringBreakdownTimeseriesDatapoint.md +22 -0
- data/docs/MonitoringBreakdownTimeseriesValues.md +20 -0
- data/docs/RealTimeApi.md +8 -6
- data/docs/SigningKeysApi.md +291 -0
- data/docs/Track.md +4 -4
- data/docs/URLSigningKeysApi.md +4 -4
- data/docs/UpdateLiveStreamRequest.md +1 -1
- data/docs/VideoView.md +33 -1
- data/examples/video/exercise-signing-keys.rb +5 -4
- data/gen/generator-config.json +1 -1
- data/gen/package.json +1 -1
- data/gen/yarn.lock +411 -318
- data/lib/mux_ruby/api/assets_api.rb +2 -2
- data/lib/mux_ruby/api/direct_uploads_api.rb +2 -2
- data/lib/mux_ruby/api/metrics_api.rb +9 -9
- data/lib/mux_ruby/api/monitoring_api.rb +110 -9
- data/lib/mux_ruby/api/real_time_api.rb +9 -6
- data/lib/mux_ruby/api/signing_keys_api.rb +266 -0
- data/lib/mux_ruby/api/url_signing_keys_api.rb +8 -8
- data/lib/mux_ruby/models/asset.rb +68 -2
- data/lib/mux_ruby/models/asset_generated_subtitle_settings.rb +275 -0
- data/lib/mux_ruby/models/asset_non_standard_input_reasons.rb +14 -4
- data/lib/mux_ruby/models/broadcast_layout.rb +1 -0
- data/lib/mux_ruby/models/create_asset_request.rb +48 -4
- data/lib/mux_ruby/models/create_live_stream_request.rb +3 -3
- data/lib/mux_ruby/models/create_track_request.rb +4 -3
- data/lib/mux_ruby/models/delivery_report.rb +35 -4
- data/lib/mux_ruby/models/delivery_report_delivered_seconds_by_resolution.rb +260 -0
- data/lib/mux_ruby/models/get_monitoring_breakdown_timeseries_response.rb +240 -0
- data/lib/mux_ruby/models/input_settings.rb +18 -6
- data/lib/mux_ruby/models/live_stream.rb +4 -4
- data/lib/mux_ruby/models/live_stream_embedded_subtitle_settings.rb +2 -2
- data/lib/mux_ruby/models/monitoring_breakdown_timeseries_datapoint.rb +236 -0
- data/lib/mux_ruby/models/monitoring_breakdown_timeseries_values.rb +229 -0
- data/lib/mux_ruby/models/track.rb +6 -6
- data/lib/mux_ruby/models/update_live_stream_request.rb +1 -1
- data/lib/mux_ruby/models/video_view.rb +162 -5
- data/lib/mux_ruby/version.rb +1 -1
- data/lib/mux_ruby.rb +6 -0
- data/spec/api/signing_keys_api_spec.rb +83 -0
- data/spec/models/asset_generated_subtitle_settings_spec.rb +50 -0
- data/spec/models/delivery_report_delivered_seconds_by_resolution_spec.rb +46 -0
- data/spec/models/get_monitoring_breakdown_timeseries_response_spec.rb +46 -0
- data/spec/models/monitoring_breakdown_timeseries_datapoint_spec.rb +46 -0
- data/spec/models/monitoring_breakdown_timeseries_values_spec.rb +40 -0
- data/test.sh +2 -2
- data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/byebug-11.1.3/byebug/byebug.so +0 -0
- data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/byebug-11.1.3/gem_make.out +6 -6
- data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/ffi-1.15.5/ffi_c.so +0 -0
- data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/ffi-1.15.5/gem_make.out +6 -6
- data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/ffi-1.15.5/mkmf.log +15 -15
- data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/jaro_winkler-1.5.4/gem_make.out +14 -14
- data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/jaro_winkler-1.5.4/jaro_winkler/jaro_winkler_ext.so +0 -0
- data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/psych-4.0.4/gem_make.out +6 -6
- data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/psych-4.0.4/mkmf.log +4 -4
- data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/psych-4.0.4/psych.so +0 -0
- data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/stringio-3.0.2/gem_make.out +6 -6
- data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/stringio-3.0.2/mkmf.log +2 -2
- data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/stringio-3.0.2/stringio.so +0 -0
- data/vendor/bundle/ruby/3.2.0/gems/byebug-11.1.3/ext/byebug/Makefile +6 -6
- data/vendor/bundle/ruby/3.2.0/gems/byebug-11.1.3/lib/byebug/byebug.so +0 -0
- data/vendor/bundle/ruby/3.2.0/gems/ffi-1.15.5/ext/ffi_c/Makefile +6 -6
- data/vendor/bundle/ruby/3.2.0/gems/ffi-1.15.5/lib/ffi_c.so +0 -0
- data/vendor/bundle/ruby/3.2.0/gems/jaro_winkler-1.5.4/ext/jaro_winkler/Makefile +6 -6
- data/vendor/bundle/ruby/3.2.0/gems/jaro_winkler-1.5.4/lib/jaro_winkler/jaro_winkler_ext.so +0 -0
- data/vendor/bundle/ruby/3.2.0/gems/psych-4.0.4/ext/psych/Makefile +6 -6
- data/vendor/bundle/ruby/3.2.0/gems/psych-4.0.4/lib/psych.so +0 -0
- data/vendor/bundle/ruby/3.2.0/gems/stringio-3.0.2/ext/stringio/Makefile +6 -6
- data/vendor/bundle/ruby/3.2.0/gems/stringio-3.0.2/lib/stringio.so +0 -0
- data/vendor/bundle/ruby/3.2.0/specifications/ast-2.4.2.gemspec +2 -2
- data/vendor/bundle/ruby/3.2.0/specifications/byebug-11.1.3.gemspec +2 -2
- data/vendor/bundle/ruby/3.2.0/specifications/coderay-1.1.3.gemspec +2 -2
- data/vendor/bundle/ruby/3.2.0/specifications/diff-lcs-1.5.0.gemspec +2 -2
- data/vendor/bundle/ruby/3.2.0/specifications/ethon-0.16.0.gemspec +2 -2
- data/vendor/bundle/ruby/3.2.0/specifications/ffi-1.15.5.gemspec +2 -2
- data/vendor/bundle/ruby/3.2.0/specifications/jaro_winkler-1.5.4.gemspec +2 -2
- data/vendor/bundle/ruby/3.2.0/specifications/method_source-1.0.0.gemspec +2 -2
- data/vendor/bundle/ruby/3.2.0/specifications/parallel-1.22.1.gemspec +2 -2
- data/vendor/bundle/ruby/3.2.0/specifications/parser-3.1.2.0.gemspec +2 -2
- data/vendor/bundle/ruby/3.2.0/specifications/pry-0.13.1.gemspec +2 -2
- data/vendor/bundle/ruby/3.2.0/specifications/pry-byebug-3.9.0.gemspec +2 -2
- data/vendor/bundle/ruby/3.2.0/specifications/psych-4.0.4.gemspec +2 -2
- data/vendor/bundle/ruby/3.2.0/specifications/rainbow-3.1.1.gemspec +2 -2
- data/vendor/bundle/ruby/3.2.0/specifications/rake-13.0.6.gemspec +2 -2
- data/vendor/bundle/ruby/3.2.0/specifications/rspec-3.11.0.gemspec +2 -2
- data/vendor/bundle/ruby/3.2.0/specifications/rspec-core-3.11.0.gemspec +2 -2
- data/vendor/bundle/ruby/3.2.0/specifications/rspec-expectations-3.11.0.gemspec +2 -2
- data/vendor/bundle/ruby/3.2.0/specifications/rspec-mocks-3.11.1.gemspec +2 -2
- data/vendor/bundle/ruby/3.2.0/specifications/rspec-support-3.11.0.gemspec +2 -2
- data/vendor/bundle/ruby/3.2.0/specifications/rubocop-0.66.0.gemspec +2 -2
- data/vendor/bundle/ruby/3.2.0/specifications/ruby-progressbar-1.11.0.gemspec +2 -2
- data/vendor/bundle/ruby/3.2.0/specifications/solid_assert-1.1.0.gemspec +2 -2
- data/vendor/bundle/ruby/3.2.0/specifications/stringio-3.0.2.gemspec +2 -2
- data/vendor/bundle/ruby/3.2.0/specifications/typhoeus-1.4.0.gemspec +2 -2
- data/vendor/bundle/ruby/3.2.0/specifications/unicode-display_width-1.5.0.gemspec +2 -2
- metadata +164 -140
|
@@ -156,7 +156,7 @@ module MuxRuby
|
|
|
156
156
|
end
|
|
157
157
|
|
|
158
158
|
# Create an asset track
|
|
159
|
-
# Adds an asset track (for example, subtitles) to an asset.
|
|
159
|
+
# Adds an asset track (for example, subtitles, or an alternate audio track) to an asset.
|
|
160
160
|
# @param asset_id [String] The asset ID.
|
|
161
161
|
# @param create_track_request [CreateTrackRequest]
|
|
162
162
|
# @param [Hash] opts the optional parameters
|
|
@@ -167,7 +167,7 @@ module MuxRuby
|
|
|
167
167
|
end
|
|
168
168
|
|
|
169
169
|
# Create an asset track
|
|
170
|
-
# Adds an asset track (for example, subtitles) to an asset.
|
|
170
|
+
# Adds an asset track (for example, subtitles, or an alternate audio track) to an asset.
|
|
171
171
|
# @param asset_id [String] The asset ID.
|
|
172
172
|
# @param create_track_request [CreateTrackRequest]
|
|
173
173
|
# @param [Hash] opts the optional parameters
|
|
@@ -211,7 +211,7 @@ module MuxRuby
|
|
|
211
211
|
end
|
|
212
212
|
|
|
213
213
|
# List direct uploads
|
|
214
|
-
# Lists
|
|
214
|
+
# Lists direct uploads in the current environment.
|
|
215
215
|
# @param [Hash] opts the optional parameters
|
|
216
216
|
# @option opts [Integer] :limit Number of items to include in the response (default to 25)
|
|
217
217
|
# @option opts [Integer] :page Offset by this many pages, of the size of `limit` (default to 1)
|
|
@@ -222,7 +222,7 @@ module MuxRuby
|
|
|
222
222
|
end
|
|
223
223
|
|
|
224
224
|
# List direct uploads
|
|
225
|
-
# Lists
|
|
225
|
+
# Lists direct uploads in the current environment.
|
|
226
226
|
# @param [Hash] opts the optional parameters
|
|
227
227
|
# @option opts [Integer] :limit Number of items to include in the response
|
|
228
228
|
# @option opts [Integer] :page Offset by this many pages, of the size of `limit`
|
|
@@ -27,7 +27,7 @@ module MuxRuby
|
|
|
27
27
|
# @option opts [Array<String>] :filters 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 `!` character to the dimension. Possible filter names are the same as returned by the List Filters endpoint. Example: * `filters[]=operating_system:windows&filters[]=!country:US`
|
|
28
28
|
# @option opts [String] :measurement Measurement for the provided metric. If omitted, the default for the metric will be used.
|
|
29
29
|
# @option opts [String] :order_direction Sort order.
|
|
30
|
-
# @option opts [String] :group_by Time granularity to group results by. If this value is omitted, a default granularity is chosen based on the timeframe. For timeframes of
|
|
30
|
+
# @option opts [String] :group_by Time granularity to group results by. If this value is omitted, a default granularity is chosen based on the timeframe. For timeframes of less than 90 minutes, the default granularity is `minute`. Between 90 minutes and 6 hours, the default granularity is `ten_minutes`. Between 6 hours and 15 days inclusive, the default granularity is `hour`. The granularity of timeframes that exceed 15 days is `day`. This default behavior is subject to change; it is strongly suggested that you explicitly specify the granularity.
|
|
31
31
|
# @return [GetMetricTimeseriesDataResponse]
|
|
32
32
|
def get_metric_timeseries_data(metric_id, opts = {})
|
|
33
33
|
data, _status_code, _headers = get_metric_timeseries_data_with_http_info(metric_id, opts)
|
|
@@ -42,7 +42,7 @@ module MuxRuby
|
|
|
42
42
|
# @option opts [Array<String>] :filters 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 `!` character to the dimension. Possible filter names are the same as returned by the List Filters endpoint. Example: * `filters[]=operating_system:windows&filters[]=!country:US`
|
|
43
43
|
# @option opts [String] :measurement Measurement for the provided metric. If omitted, the default for the metric will be used.
|
|
44
44
|
# @option opts [String] :order_direction Sort order.
|
|
45
|
-
# @option opts [String] :group_by Time granularity to group results by. If this value is omitted, a default granularity is chosen based on the timeframe. For timeframes of
|
|
45
|
+
# @option opts [String] :group_by Time granularity to group results by. If this value is omitted, a default granularity is chosen based on the timeframe. For timeframes of less than 90 minutes, the default granularity is `minute`. Between 90 minutes and 6 hours, the default granularity is `ten_minutes`. Between 6 hours and 15 days inclusive, the default granularity is `hour`. The granularity of timeframes that exceed 15 days is `day`. This default behavior is subject to change; it is strongly suggested that you explicitly specify the granularity.
|
|
46
46
|
# @return [Array<(GetMetricTimeseriesDataResponse, Integer, Hash)>] GetMetricTimeseriesDataResponse data, response status code and response headers
|
|
47
47
|
def get_metric_timeseries_data_with_http_info(metric_id, opts = {})
|
|
48
48
|
if @api_client.config.debugging
|
|
@@ -53,7 +53,7 @@ module MuxRuby
|
|
|
53
53
|
fail ArgumentError, "Missing the required parameter 'metric_id' when calling MetricsApi.get_metric_timeseries_data"
|
|
54
54
|
end
|
|
55
55
|
# verify enum value
|
|
56
|
-
allowable_values = ["aggregate_startup_time", "downscale_percentage", "exits_before_video_start", "max_downscale_percentage", "max_upscale_percentage", "page_load_time", "playback_failure_percentage", "playback_failure_score", "player_startup_time", "playing_time", "rebuffer_count", "rebuffer_duration", "rebuffer_frequency", "rebuffer_percentage", "rebuffer_score", "requests_for_first_preroll", "seek_latency", "startup_time_score", "unique_viewers", "upscale_percentage", "video_quality_score", "video_startup_preroll_load_time", "video_startup_preroll_request_time", "video_startup_time", "viewer_experience_score", "views", "weighted_average_bitrate"]
|
|
56
|
+
allowable_values = ["aggregate_startup_time", "downscale_percentage", "exits_before_video_start", "live_stream_latency", "max_downscale_percentage", "max_upscale_percentage", "page_load_time", "playback_failure_percentage", "playback_failure_score", "player_startup_time", "playing_time", "rebuffer_count", "rebuffer_duration", "rebuffer_frequency", "rebuffer_percentage", "rebuffer_score", "requests_for_first_preroll", "seek_latency", "startup_time_score", "unique_viewers", "upscale_percentage", "video_quality_score", "video_startup_preroll_load_time", "video_startup_preroll_request_time", "video_startup_time", "viewer_experience_score", "views", "weighted_average_bitrate", "video_startup_failure_percentage"]
|
|
57
57
|
if @api_client.config.client_side_validation && !allowable_values.include?(metric_id)
|
|
58
58
|
fail ArgumentError, "invalid value for \"metric_id\", must be one of #{allowable_values}"
|
|
59
59
|
end
|
|
@@ -65,7 +65,7 @@ module MuxRuby
|
|
|
65
65
|
if @api_client.config.client_side_validation && opts[:'order_direction'] && !allowable_values.include?(opts[:'order_direction'])
|
|
66
66
|
fail ArgumentError, "invalid value for \"order_direction\", must be one of #{allowable_values}"
|
|
67
67
|
end
|
|
68
|
-
allowable_values = ["ten_minutes", "hour", "day"]
|
|
68
|
+
allowable_values = ["minute", "ten_minutes", "hour", "day"]
|
|
69
69
|
if @api_client.config.client_side_validation && opts[:'group_by'] && !allowable_values.include?(opts[:'group_by'])
|
|
70
70
|
fail ArgumentError, "invalid value for \"group_by\", must be one of #{allowable_values}"
|
|
71
71
|
end
|
|
@@ -144,7 +144,7 @@ module MuxRuby
|
|
|
144
144
|
fail ArgumentError, "Missing the required parameter 'metric_id' when calling MetricsApi.get_overall_values"
|
|
145
145
|
end
|
|
146
146
|
# verify enum value
|
|
147
|
-
allowable_values = ["aggregate_startup_time", "downscale_percentage", "exits_before_video_start", "max_downscale_percentage", "max_upscale_percentage", "page_load_time", "playback_failure_percentage", "playback_failure_score", "player_startup_time", "playing_time", "rebuffer_count", "rebuffer_duration", "rebuffer_frequency", "rebuffer_percentage", "rebuffer_score", "requests_for_first_preroll", "seek_latency", "startup_time_score", "unique_viewers", "upscale_percentage", "video_quality_score", "video_startup_preroll_load_time", "video_startup_preroll_request_time", "video_startup_time", "viewer_experience_score", "views", "weighted_average_bitrate"]
|
|
147
|
+
allowable_values = ["aggregate_startup_time", "downscale_percentage", "exits_before_video_start", "live_stream_latency", "max_downscale_percentage", "max_upscale_percentage", "page_load_time", "playback_failure_percentage", "playback_failure_score", "player_startup_time", "playing_time", "rebuffer_count", "rebuffer_duration", "rebuffer_frequency", "rebuffer_percentage", "rebuffer_score", "requests_for_first_preroll", "seek_latency", "startup_time_score", "unique_viewers", "upscale_percentage", "video_quality_score", "video_startup_preroll_load_time", "video_startup_preroll_request_time", "video_startup_time", "viewer_experience_score", "views", "weighted_average_bitrate", "video_startup_failure_percentage"]
|
|
148
148
|
if @api_client.config.client_side_validation && !allowable_values.include?(metric_id)
|
|
149
149
|
fail ArgumentError, "invalid value for \"metric_id\", must be one of #{allowable_values}"
|
|
150
150
|
end
|
|
@@ -220,7 +220,7 @@ module MuxRuby
|
|
|
220
220
|
if @api_client.config.debugging
|
|
221
221
|
@api_client.config.logger.debug 'Calling API: MetricsApi.list_all_metric_values ...'
|
|
222
222
|
end
|
|
223
|
-
allowable_values = ["asn", "browser", "browser_version", "cdn", "continent_code", "country", "exit_before_video_start", "experiment_name", "operating_system", "operating_system_version", "player_autoplay", "player_error_code", "player_mux_plugin_name", "player_mux_plugin_version", "player_name", "player_preload", "player_remote_played", "player_software", "player_software_version", "player_version", "preroll_ad_asset_hostname", "preroll_ad_tag_hostname", "preroll_played", "preroll_requested", "region", "source_hostname", "source_type", "stream_type", "sub_property_id", "video_encoding_variant", "video_id", "video_series", "video_title", "view_session_id", "viewer_connection_type", "viewer_device_category", "viewer_device_manufacturer", "viewer_device_model", "viewer_device_name", "viewer_user_id"]
|
|
223
|
+
allowable_values = ["asn", "asset_id", "browser", "browser_version", "cdn", "continent_code", "country", "custom_1", "custom_2", "custom_3", "custom_4", "custom_5", "custom_6", "custom_7", "custom_8", "custom_9", "custom_10", "exit_before_video_start", "experiment_name", "live_stream_id", "operating_system", "operating_system_version", "playback_id", "player_autoplay", "player_error_code", "player_mux_plugin_name", "player_mux_plugin_version", "player_name", "player_preload", "player_remote_played", "player_software", "player_software_version", "player_version", "preroll_ad_asset_hostname", "preroll_ad_tag_hostname", "preroll_played", "preroll_requested", "region", "source_hostname", "source_type", "stream_type", "sub_property_id", "video_encoding_variant", "video_id", "video_series", "video_startup_failure", "video_title", "view_drm_type", "view_has_ad", "view_session_id", "viewer_connection_type", "viewer_device_category", "viewer_device_manufacturer", "viewer_device_model", "viewer_device_name", "viewer_user_id"]
|
|
224
224
|
if @api_client.config.client_side_validation && opts[:'dimension'] && !allowable_values.include?(opts[:'dimension'])
|
|
225
225
|
fail ArgumentError, "invalid value for \"dimension\", must be one of #{allowable_values}"
|
|
226
226
|
end
|
|
@@ -308,11 +308,11 @@ module MuxRuby
|
|
|
308
308
|
fail ArgumentError, "Missing the required parameter 'metric_id' when calling MetricsApi.list_breakdown_values"
|
|
309
309
|
end
|
|
310
310
|
# verify enum value
|
|
311
|
-
allowable_values = ["aggregate_startup_time", "downscale_percentage", "exits_before_video_start", "max_downscale_percentage", "max_upscale_percentage", "page_load_time", "playback_failure_percentage", "playback_failure_score", "player_startup_time", "playing_time", "rebuffer_count", "rebuffer_duration", "rebuffer_frequency", "rebuffer_percentage", "rebuffer_score", "requests_for_first_preroll", "seek_latency", "startup_time_score", "unique_viewers", "upscale_percentage", "video_quality_score", "video_startup_preroll_load_time", "video_startup_preroll_request_time", "video_startup_time", "viewer_experience_score", "views", "weighted_average_bitrate"]
|
|
311
|
+
allowable_values = ["aggregate_startup_time", "downscale_percentage", "exits_before_video_start", "live_stream_latency", "max_downscale_percentage", "max_upscale_percentage", "page_load_time", "playback_failure_percentage", "playback_failure_score", "player_startup_time", "playing_time", "rebuffer_count", "rebuffer_duration", "rebuffer_frequency", "rebuffer_percentage", "rebuffer_score", "requests_for_first_preroll", "seek_latency", "startup_time_score", "unique_viewers", "upscale_percentage", "video_quality_score", "video_startup_preroll_load_time", "video_startup_preroll_request_time", "video_startup_time", "viewer_experience_score", "views", "weighted_average_bitrate", "video_startup_failure_percentage"]
|
|
312
312
|
if @api_client.config.client_side_validation && !allowable_values.include?(metric_id)
|
|
313
313
|
fail ArgumentError, "invalid value for \"metric_id\", must be one of #{allowable_values}"
|
|
314
314
|
end
|
|
315
|
-
allowable_values = ["asn", "browser", "browser_version", "cdn", "continent_code", "country", "exit_before_video_start", "experiment_name", "operating_system", "operating_system_version", "player_autoplay", "player_error_code", "player_mux_plugin_name", "player_mux_plugin_version", "player_name", "player_preload", "player_remote_played", "player_software", "player_software_version", "player_version", "preroll_ad_asset_hostname", "preroll_ad_tag_hostname", "preroll_played", "preroll_requested", "region", "source_hostname", "source_type", "stream_type", "sub_property_id", "video_encoding_variant", "video_id", "video_series", "video_title", "view_session_id", "viewer_connection_type", "viewer_device_category", "viewer_device_manufacturer", "viewer_device_model", "viewer_device_name", "viewer_user_id"]
|
|
315
|
+
allowable_values = ["asn", "asset_id", "browser", "browser_version", "cdn", "continent_code", "country", "custom_1", "custom_2", "custom_3", "custom_4", "custom_5", "custom_6", "custom_7", "custom_8", "custom_9", "custom_10", "exit_before_video_start", "experiment_name", "live_stream_id", "operating_system", "operating_system_version", "playback_id", "player_autoplay", "player_error_code", "player_mux_plugin_name", "player_mux_plugin_version", "player_name", "player_preload", "player_remote_played", "player_software", "player_software_version", "player_version", "preroll_ad_asset_hostname", "preroll_ad_tag_hostname", "preroll_played", "preroll_requested", "region", "source_hostname", "source_type", "stream_type", "sub_property_id", "video_encoding_variant", "video_id", "video_series", "video_startup_failure", "video_title", "view_drm_type", "view_has_ad", "view_session_id", "viewer_connection_type", "viewer_device_category", "viewer_device_manufacturer", "viewer_device_model", "viewer_device_name", "viewer_user_id"]
|
|
316
316
|
if @api_client.config.client_side_validation && opts[:'group_by'] && !allowable_values.include?(opts[:'group_by'])
|
|
317
317
|
fail ArgumentError, "invalid value for \"group_by\", must be one of #{allowable_values}"
|
|
318
318
|
end
|
|
@@ -406,7 +406,7 @@ module MuxRuby
|
|
|
406
406
|
fail ArgumentError, "Missing the required parameter 'metric_id' when calling MetricsApi.list_insights"
|
|
407
407
|
end
|
|
408
408
|
# verify enum value
|
|
409
|
-
allowable_values = ["aggregate_startup_time", "downscale_percentage", "exits_before_video_start", "max_downscale_percentage", "max_upscale_percentage", "page_load_time", "playback_failure_percentage", "playback_failure_score", "player_startup_time", "playing_time", "rebuffer_count", "rebuffer_duration", "rebuffer_frequency", "rebuffer_percentage", "rebuffer_score", "requests_for_first_preroll", "seek_latency", "startup_time_score", "unique_viewers", "upscale_percentage", "video_quality_score", "video_startup_preroll_load_time", "video_startup_preroll_request_time", "video_startup_time", "viewer_experience_score", "views", "weighted_average_bitrate"]
|
|
409
|
+
allowable_values = ["aggregate_startup_time", "downscale_percentage", "exits_before_video_start", "live_stream_latency", "max_downscale_percentage", "max_upscale_percentage", "page_load_time", "playback_failure_percentage", "playback_failure_score", "player_startup_time", "playing_time", "rebuffer_count", "rebuffer_duration", "rebuffer_frequency", "rebuffer_percentage", "rebuffer_score", "requests_for_first_preroll", "seek_latency", "startup_time_score", "unique_viewers", "upscale_percentage", "video_quality_score", "video_startup_preroll_load_time", "video_startup_preroll_request_time", "video_startup_time", "viewer_experience_score", "views", "weighted_average_bitrate", "video_startup_failure_percentage"]
|
|
410
410
|
if @api_client.config.client_side_validation && !allowable_values.include?(metric_id)
|
|
411
411
|
fail ArgumentError, "invalid value for \"metric_id\", must be one of #{allowable_values}"
|
|
412
412
|
end
|
|
@@ -25,7 +25,7 @@ module MuxRuby
|
|
|
25
25
|
# @param [Hash] opts the optional parameters
|
|
26
26
|
# @option opts [String] :dimension Dimension the specified value belongs to
|
|
27
27
|
# @option opts [Integer] :timestamp Timestamp to limit results by. This value must be provided as a unix timestamp. Defaults to the current unix timestamp.
|
|
28
|
-
# @option opts [Array<String>] :filters 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 `!` character to the dimension. Possible filter names are the same as returned by the List
|
|
28
|
+
# @option opts [Array<String>] :filters 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 `!` character to the dimension. Possible filter names are the same as returned by the List Monitoring Dimensions endpoint. Example: * `filters[]=operating_system:windows&filters[]=!country:US`
|
|
29
29
|
# @option opts [String] :order_by Value to order the results by
|
|
30
30
|
# @option opts [String] :order_direction Sort order.
|
|
31
31
|
# @return [GetMonitoringBreakdownResponse]
|
|
@@ -40,7 +40,7 @@ module MuxRuby
|
|
|
40
40
|
# @param [Hash] opts the optional parameters
|
|
41
41
|
# @option opts [String] :dimension Dimension the specified value belongs to
|
|
42
42
|
# @option opts [Integer] :timestamp Timestamp to limit results by. This value must be provided as a unix timestamp. Defaults to the current unix timestamp.
|
|
43
|
-
# @option opts [Array<String>] :filters 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 `!` character to the dimension. Possible filter names are the same as returned by the List
|
|
43
|
+
# @option opts [Array<String>] :filters 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 `!` character to the dimension. Possible filter names are the same as returned by the List Monitoring Dimensions endpoint. Example: * `filters[]=operating_system:windows&filters[]=!country:US`
|
|
44
44
|
# @option opts [String] :order_by Value to order the results by
|
|
45
45
|
# @option opts [String] :order_direction Sort order.
|
|
46
46
|
# @return [Array<(GetMonitoringBreakdownResponse, Integer, Hash)>] GetMonitoringBreakdownResponse data, response status code and response headers
|
|
@@ -53,11 +53,11 @@ module MuxRuby
|
|
|
53
53
|
fail ArgumentError, "Missing the required parameter 'monitoring_metric_id' when calling MonitoringApi.get_monitoring_breakdown"
|
|
54
54
|
end
|
|
55
55
|
# verify enum value
|
|
56
|
-
allowable_values = ["current-concurrent-viewers", "current-rebuffering-percentage", "exits-before-video-start", "playback-failure-percentage", "current-average-bitrate"]
|
|
56
|
+
allowable_values = ["current-concurrent-viewers", "current-rebuffering-percentage", "exits-before-video-start", "playback-failure-percentage", "current-average-bitrate", "video-startup-failure-percentage"]
|
|
57
57
|
if @api_client.config.client_side_validation && !allowable_values.include?(monitoring_metric_id)
|
|
58
58
|
fail ArgumentError, "invalid value for \"monitoring_metric_id\", must be one of #{allowable_values}"
|
|
59
59
|
end
|
|
60
|
-
allowable_values = ["asn", "cdn", "country", "operating_system", "player_name", "region", "stream_type", "sub_property_id", "video_series", "video_title"]
|
|
60
|
+
allowable_values = ["asn", "cdn", "country", "operating_system", "player_name", "region", "stream_type", "sub_property_id", "video_series", "video_title", "view_has_ad"]
|
|
61
61
|
if @api_client.config.client_side_validation && opts[:'dimension'] && !allowable_values.include?(opts[:'dimension'])
|
|
62
62
|
fail ArgumentError, "invalid value for \"dimension\", must be one of #{allowable_values}"
|
|
63
63
|
end
|
|
@@ -114,11 +114,109 @@ module MuxRuby
|
|
|
114
114
|
return data, status_code, headers
|
|
115
115
|
end
|
|
116
116
|
|
|
117
|
+
# Get Monitoring Breakdown Timeseries
|
|
118
|
+
# Gets timeseries of breakdown information for a specific dimension and metric. Each datapoint in the response represents 5 seconds worth of data.
|
|
119
|
+
# @param monitoring_metric_id [String] ID of the Monitoring Metric
|
|
120
|
+
# @param [Hash] opts the optional parameters
|
|
121
|
+
# @option opts [String] :dimension Dimension the specified value belongs to
|
|
122
|
+
# @option opts [Array<String>] :timeframe Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]=). 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.
|
|
123
|
+
# @option opts [Array<String>] :filters 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 `!` character to the dimension. Possible filter names are the same as returned by the List Monitoring Dimensions endpoint. Example: * `filters[]=operating_system:windows&filters[]=!country:US`
|
|
124
|
+
# @option opts [Integer] :limit Number of items to include in each timestamp's `value` list. The default is 10, and the maximum is 100. (default to 10)
|
|
125
|
+
# @option opts [String] :order_by Value to order the results by
|
|
126
|
+
# @option opts [String] :order_direction Sort order.
|
|
127
|
+
# @return [GetMonitoringBreakdownTimeseriesResponse]
|
|
128
|
+
def get_monitoring_breakdown_timeseries(monitoring_metric_id, opts = {})
|
|
129
|
+
data, _status_code, _headers = get_monitoring_breakdown_timeseries_with_http_info(monitoring_metric_id, opts)
|
|
130
|
+
data
|
|
131
|
+
end
|
|
132
|
+
|
|
133
|
+
# Get Monitoring Breakdown Timeseries
|
|
134
|
+
# Gets timeseries of breakdown information for a specific dimension and metric. Each datapoint in the response represents 5 seconds worth of data.
|
|
135
|
+
# @param monitoring_metric_id [String] ID of the Monitoring Metric
|
|
136
|
+
# @param [Hash] opts the optional parameters
|
|
137
|
+
# @option opts [String] :dimension Dimension the specified value belongs to
|
|
138
|
+
# @option opts [Array<String>] :timeframe Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]=). 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.
|
|
139
|
+
# @option opts [Array<String>] :filters 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 `!` character to the dimension. Possible filter names are the same as returned by the List Monitoring Dimensions endpoint. Example: * `filters[]=operating_system:windows&filters[]=!country:US`
|
|
140
|
+
# @option opts [Integer] :limit Number of items to include in each timestamp's `value` list. The default is 10, and the maximum is 100.
|
|
141
|
+
# @option opts [String] :order_by Value to order the results by
|
|
142
|
+
# @option opts [String] :order_direction Sort order.
|
|
143
|
+
# @return [Array<(GetMonitoringBreakdownTimeseriesResponse, Integer, Hash)>] GetMonitoringBreakdownTimeseriesResponse data, response status code and response headers
|
|
144
|
+
def get_monitoring_breakdown_timeseries_with_http_info(monitoring_metric_id, opts = {})
|
|
145
|
+
if @api_client.config.debugging
|
|
146
|
+
@api_client.config.logger.debug 'Calling API: MonitoringApi.get_monitoring_breakdown_timeseries ...'
|
|
147
|
+
end
|
|
148
|
+
# verify the required parameter 'monitoring_metric_id' is set
|
|
149
|
+
if @api_client.config.client_side_validation && monitoring_metric_id.nil?
|
|
150
|
+
fail ArgumentError, "Missing the required parameter 'monitoring_metric_id' when calling MonitoringApi.get_monitoring_breakdown_timeseries"
|
|
151
|
+
end
|
|
152
|
+
# verify enum value
|
|
153
|
+
allowable_values = ["current-concurrent-viewers", "current-rebuffering-percentage", "exits-before-video-start", "playback-failure-percentage", "current-average-bitrate", "video-startup-failure-percentage"]
|
|
154
|
+
if @api_client.config.client_side_validation && !allowable_values.include?(monitoring_metric_id)
|
|
155
|
+
fail ArgumentError, "invalid value for \"monitoring_metric_id\", must be one of #{allowable_values}"
|
|
156
|
+
end
|
|
157
|
+
allowable_values = ["asn", "cdn", "country", "operating_system", "player_name", "region", "stream_type", "sub_property_id", "video_series", "video_title", "view_has_ad"]
|
|
158
|
+
if @api_client.config.client_side_validation && opts[:'dimension'] && !allowable_values.include?(opts[:'dimension'])
|
|
159
|
+
fail ArgumentError, "invalid value for \"dimension\", must be one of #{allowable_values}"
|
|
160
|
+
end
|
|
161
|
+
allowable_values = ["negative_impact", "value", "views", "field"]
|
|
162
|
+
if @api_client.config.client_side_validation && opts[:'order_by'] && !allowable_values.include?(opts[:'order_by'])
|
|
163
|
+
fail ArgumentError, "invalid value for \"order_by\", must be one of #{allowable_values}"
|
|
164
|
+
end
|
|
165
|
+
allowable_values = ["asc", "desc"]
|
|
166
|
+
if @api_client.config.client_side_validation && opts[:'order_direction'] && !allowable_values.include?(opts[:'order_direction'])
|
|
167
|
+
fail ArgumentError, "invalid value for \"order_direction\", must be one of #{allowable_values}"
|
|
168
|
+
end
|
|
169
|
+
# resource path
|
|
170
|
+
local_var_path = '/data/v1/monitoring/metrics/{MONITORING_METRIC_ID}/breakdown-timeseries'.sub('{' + 'MONITORING_METRIC_ID' + '}', CGI.escape(monitoring_metric_id.to_s))
|
|
171
|
+
|
|
172
|
+
# query parameters
|
|
173
|
+
query_params = opts[:query_params] || {}
|
|
174
|
+
query_params[:'dimension'] = opts[:'dimension'] if !opts[:'dimension'].nil?
|
|
175
|
+
query_params[:'timeframe[]'] = @api_client.build_collection_param(opts[:'timeframe'], :multi) if !opts[:'timeframe'].nil?
|
|
176
|
+
query_params[:'filters[]'] = @api_client.build_collection_param(opts[:'filters'], :multi) if !opts[:'filters'].nil?
|
|
177
|
+
query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
|
|
178
|
+
query_params[:'order_by'] = opts[:'order_by'] if !opts[:'order_by'].nil?
|
|
179
|
+
query_params[:'order_direction'] = opts[:'order_direction'] if !opts[:'order_direction'].nil?
|
|
180
|
+
|
|
181
|
+
# header parameters
|
|
182
|
+
header_params = opts[:header_params] || {}
|
|
183
|
+
# HTTP header 'Accept' (if needed)
|
|
184
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
185
|
+
|
|
186
|
+
# form parameters
|
|
187
|
+
form_params = opts[:form_params] || {}
|
|
188
|
+
|
|
189
|
+
# http body (model)
|
|
190
|
+
post_body = opts[:debug_body]
|
|
191
|
+
|
|
192
|
+
# return_type
|
|
193
|
+
return_type = opts[:debug_return_type] || 'GetMonitoringBreakdownTimeseriesResponse'
|
|
194
|
+
|
|
195
|
+
# auth_names
|
|
196
|
+
auth_names = opts[:debug_auth_names] || ['accessToken']
|
|
197
|
+
|
|
198
|
+
new_options = opts.merge(
|
|
199
|
+
:operation => :"MonitoringApi.get_monitoring_breakdown_timeseries",
|
|
200
|
+
:header_params => header_params,
|
|
201
|
+
:query_params => query_params,
|
|
202
|
+
:form_params => form_params,
|
|
203
|
+
:body => post_body,
|
|
204
|
+
:auth_names => auth_names,
|
|
205
|
+
:return_type => return_type
|
|
206
|
+
)
|
|
207
|
+
|
|
208
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
209
|
+
if @api_client.config.debugging
|
|
210
|
+
@api_client.config.logger.debug "API called: MonitoringApi#get_monitoring_breakdown_timeseries\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
211
|
+
end
|
|
212
|
+
return data, status_code, headers
|
|
213
|
+
end
|
|
214
|
+
|
|
117
215
|
# Get Monitoring Histogram Timeseries
|
|
118
216
|
# Gets histogram timeseries information for a specific metric.
|
|
119
217
|
# @param monitoring_histogram_metric_id [String] ID of the Monitoring Histogram Metric
|
|
120
218
|
# @param [Hash] opts the optional parameters
|
|
121
|
-
# @option opts [Array<String>] :filters 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 `!` character to the dimension. Possible filter names are the same as returned by the List
|
|
219
|
+
# @option opts [Array<String>] :filters 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 `!` character to the dimension. Possible filter names are the same as returned by the List Monitoring Dimensions endpoint. Example: * `filters[]=operating_system:windows&filters[]=!country:US`
|
|
122
220
|
# @return [GetMonitoringHistogramTimeseriesResponse]
|
|
123
221
|
def get_monitoring_histogram_timeseries(monitoring_histogram_metric_id, opts = {})
|
|
124
222
|
data, _status_code, _headers = get_monitoring_histogram_timeseries_with_http_info(monitoring_histogram_metric_id, opts)
|
|
@@ -129,7 +227,7 @@ module MuxRuby
|
|
|
129
227
|
# Gets histogram timeseries information for a specific metric.
|
|
130
228
|
# @param monitoring_histogram_metric_id [String] ID of the Monitoring Histogram Metric
|
|
131
229
|
# @param [Hash] opts the optional parameters
|
|
132
|
-
# @option opts [Array<String>] :filters 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 `!` character to the dimension. Possible filter names are the same as returned by the List
|
|
230
|
+
# @option opts [Array<String>] :filters 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 `!` character to the dimension. Possible filter names are the same as returned by the List Monitoring Dimensions endpoint. Example: * `filters[]=operating_system:windows&filters[]=!country:US`
|
|
133
231
|
# @return [Array<(GetMonitoringHistogramTimeseriesResponse, Integer, Hash)>] GetMonitoringHistogramTimeseriesResponse data, response status code and response headers
|
|
134
232
|
def get_monitoring_histogram_timeseries_with_http_info(monitoring_histogram_metric_id, opts = {})
|
|
135
233
|
if @api_client.config.debugging
|
|
@@ -189,7 +287,8 @@ module MuxRuby
|
|
|
189
287
|
# Gets Time series information for a specific metric along with the number of concurrent viewers.
|
|
190
288
|
# @param monitoring_metric_id [String] ID of the Monitoring Metric
|
|
191
289
|
# @param [Hash] opts the optional parameters
|
|
192
|
-
# @option opts [Array<String>] :filters 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 `!` character to the dimension. Possible filter names are the same as returned by the List
|
|
290
|
+
# @option opts [Array<String>] :filters 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 `!` character to the dimension. Possible filter names are the same as returned by the List Monitoring Dimensions endpoint. Example: * `filters[]=operating_system:windows&filters[]=!country:US`
|
|
291
|
+
# @option opts [Integer] :timestamp Timestamp to use as the start of the timeseries data. This value must be provided as a unix timestamp. Defaults to 30 minutes ago.
|
|
193
292
|
# @return [GetMonitoringTimeseriesResponse]
|
|
194
293
|
def get_monitoring_timeseries(monitoring_metric_id, opts = {})
|
|
195
294
|
data, _status_code, _headers = get_monitoring_timeseries_with_http_info(monitoring_metric_id, opts)
|
|
@@ -200,7 +299,8 @@ module MuxRuby
|
|
|
200
299
|
# Gets Time series information for a specific metric along with the number of concurrent viewers.
|
|
201
300
|
# @param monitoring_metric_id [String] ID of the Monitoring Metric
|
|
202
301
|
# @param [Hash] opts the optional parameters
|
|
203
|
-
# @option opts [Array<String>] :filters 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 `!` character to the dimension. Possible filter names are the same as returned by the List
|
|
302
|
+
# @option opts [Array<String>] :filters 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 `!` character to the dimension. Possible filter names are the same as returned by the List Monitoring Dimensions endpoint. Example: * `filters[]=operating_system:windows&filters[]=!country:US`
|
|
303
|
+
# @option opts [Integer] :timestamp Timestamp to use as the start of the timeseries data. This value must be provided as a unix timestamp. Defaults to 30 minutes ago.
|
|
204
304
|
# @return [Array<(GetMonitoringTimeseriesResponse, Integer, Hash)>] GetMonitoringTimeseriesResponse data, response status code and response headers
|
|
205
305
|
def get_monitoring_timeseries_with_http_info(monitoring_metric_id, opts = {})
|
|
206
306
|
if @api_client.config.debugging
|
|
@@ -211,7 +311,7 @@ module MuxRuby
|
|
|
211
311
|
fail ArgumentError, "Missing the required parameter 'monitoring_metric_id' when calling MonitoringApi.get_monitoring_timeseries"
|
|
212
312
|
end
|
|
213
313
|
# verify enum value
|
|
214
|
-
allowable_values = ["current-concurrent-viewers", "current-rebuffering-percentage", "exits-before-video-start", "playback-failure-percentage", "current-average-bitrate"]
|
|
314
|
+
allowable_values = ["current-concurrent-viewers", "current-rebuffering-percentage", "exits-before-video-start", "playback-failure-percentage", "current-average-bitrate", "video-startup-failure-percentage"]
|
|
215
315
|
if @api_client.config.client_side_validation && !allowable_values.include?(monitoring_metric_id)
|
|
216
316
|
fail ArgumentError, "invalid value for \"monitoring_metric_id\", must be one of #{allowable_values}"
|
|
217
317
|
end
|
|
@@ -221,6 +321,7 @@ module MuxRuby
|
|
|
221
321
|
# query parameters
|
|
222
322
|
query_params = opts[:query_params] || {}
|
|
223
323
|
query_params[:'filters[]'] = @api_client.build_collection_param(opts[:'filters'], :multi) if !opts[:'filters'].nil?
|
|
324
|
+
query_params[:'timestamp'] = opts[:'timestamp'] if !opts[:'timestamp'].nil?
|
|
224
325
|
|
|
225
326
|
# header parameters
|
|
226
327
|
header_params = opts[:header_params] || {}
|
|
@@ -25,7 +25,7 @@ module MuxRuby
|
|
|
25
25
|
# @param [Hash] opts the optional parameters
|
|
26
26
|
# @option opts [String] :dimension Dimension the specified value belongs to
|
|
27
27
|
# @option opts [Integer] :timestamp Timestamp to limit results by. This value must be provided as a unix timestamp. Defaults to the current unix timestamp.
|
|
28
|
-
# @option opts [Array<String>] :filters 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 `!` character to the dimension. Possible filter names are the same as returned by the List
|
|
28
|
+
# @option opts [Array<String>] :filters 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 `!` character to the dimension. Possible filter names are the same as returned by the List Monitoring Dimensions endpoint. Example: * `filters[]=operating_system:windows&filters[]=!country:US`
|
|
29
29
|
# @option opts [String] :order_by Value to order the results by
|
|
30
30
|
# @option opts [String] :order_direction Sort order.
|
|
31
31
|
# @return [GetRealTimeBreakdownResponse]
|
|
@@ -40,7 +40,7 @@ module MuxRuby
|
|
|
40
40
|
# @param [Hash] opts the optional parameters
|
|
41
41
|
# @option opts [String] :dimension Dimension the specified value belongs to
|
|
42
42
|
# @option opts [Integer] :timestamp Timestamp to limit results by. This value must be provided as a unix timestamp. Defaults to the current unix timestamp.
|
|
43
|
-
# @option opts [Array<String>] :filters 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 `!` character to the dimension. Possible filter names are the same as returned by the List
|
|
43
|
+
# @option opts [Array<String>] :filters 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 `!` character to the dimension. Possible filter names are the same as returned by the List Monitoring Dimensions endpoint. Example: * `filters[]=operating_system:windows&filters[]=!country:US`
|
|
44
44
|
# @option opts [String] :order_by Value to order the results by
|
|
45
45
|
# @option opts [String] :order_direction Sort order.
|
|
46
46
|
# @return [Array<(GetRealTimeBreakdownResponse, Integer, Hash)>] GetRealTimeBreakdownResponse data, response status code and response headers
|
|
@@ -118,7 +118,7 @@ module MuxRuby
|
|
|
118
118
|
# Gets histogram timeseries information for a specific metric. This API is now deprecated, please use the `Get Monitoring Histogram Timeseries` API.
|
|
119
119
|
# @param realtime_histogram_metric_id [String] ID of the Realtime Histogram Metric
|
|
120
120
|
# @param [Hash] opts the optional parameters
|
|
121
|
-
# @option opts [Array<String>] :filters 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 `!` character to the dimension. Possible filter names are the same as returned by the List
|
|
121
|
+
# @option opts [Array<String>] :filters 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 `!` character to the dimension. Possible filter names are the same as returned by the List Monitoring Dimensions endpoint. Example: * `filters[]=operating_system:windows&filters[]=!country:US`
|
|
122
122
|
# @return [GetRealTimeHistogramTimeseriesResponse]
|
|
123
123
|
def get_realtime_histogram_timeseries(realtime_histogram_metric_id, opts = {})
|
|
124
124
|
data, _status_code, _headers = get_realtime_histogram_timeseries_with_http_info(realtime_histogram_metric_id, opts)
|
|
@@ -129,7 +129,7 @@ module MuxRuby
|
|
|
129
129
|
# Gets histogram timeseries information for a specific metric. This API is now deprecated, please use the `Get Monitoring Histogram Timeseries` API.
|
|
130
130
|
# @param realtime_histogram_metric_id [String] ID of the Realtime Histogram Metric
|
|
131
131
|
# @param [Hash] opts the optional parameters
|
|
132
|
-
# @option opts [Array<String>] :filters 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 `!` character to the dimension. Possible filter names are the same as returned by the List
|
|
132
|
+
# @option opts [Array<String>] :filters 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 `!` character to the dimension. Possible filter names are the same as returned by the List Monitoring Dimensions endpoint. Example: * `filters[]=operating_system:windows&filters[]=!country:US`
|
|
133
133
|
# @return [Array<(GetRealTimeHistogramTimeseriesResponse, Integer, Hash)>] GetRealTimeHistogramTimeseriesResponse data, response status code and response headers
|
|
134
134
|
def get_realtime_histogram_timeseries_with_http_info(realtime_histogram_metric_id, opts = {})
|
|
135
135
|
if @api_client.config.debugging
|
|
@@ -189,7 +189,8 @@ module MuxRuby
|
|
|
189
189
|
# 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.
|
|
190
190
|
# @param realtime_metric_id [String] ID of the Realtime Metric
|
|
191
191
|
# @param [Hash] opts the optional parameters
|
|
192
|
-
# @option opts [Array<String>] :filters 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 `!` character to the dimension. Possible filter names are the same as returned by the List
|
|
192
|
+
# @option opts [Array<String>] :filters 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 `!` character to the dimension. Possible filter names are the same as returned by the List Monitoring Dimensions endpoint. Example: * `filters[]=operating_system:windows&filters[]=!country:US`
|
|
193
|
+
# @option opts [Integer] :timestamp Timestamp to use as the start of the timeseries data. This value must be provided as a unix timestamp. Defaults to 30 minutes ago.
|
|
193
194
|
# @return [GetRealTimeTimeseriesResponse]
|
|
194
195
|
def get_realtime_timeseries(realtime_metric_id, opts = {})
|
|
195
196
|
data, _status_code, _headers = get_realtime_timeseries_with_http_info(realtime_metric_id, opts)
|
|
@@ -200,7 +201,8 @@ module MuxRuby
|
|
|
200
201
|
# 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.
|
|
201
202
|
# @param realtime_metric_id [String] ID of the Realtime Metric
|
|
202
203
|
# @param [Hash] opts the optional parameters
|
|
203
|
-
# @option opts [Array<String>] :filters 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 `!` character to the dimension. Possible filter names are the same as returned by the List
|
|
204
|
+
# @option opts [Array<String>] :filters 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 `!` character to the dimension. Possible filter names are the same as returned by the List Monitoring Dimensions endpoint. Example: * `filters[]=operating_system:windows&filters[]=!country:US`
|
|
205
|
+
# @option opts [Integer] :timestamp Timestamp to use as the start of the timeseries data. This value must be provided as a unix timestamp. Defaults to 30 minutes ago.
|
|
204
206
|
# @return [Array<(GetRealTimeTimeseriesResponse, Integer, Hash)>] GetRealTimeTimeseriesResponse data, response status code and response headers
|
|
205
207
|
def get_realtime_timeseries_with_http_info(realtime_metric_id, opts = {})
|
|
206
208
|
if @api_client.config.debugging
|
|
@@ -221,6 +223,7 @@ module MuxRuby
|
|
|
221
223
|
# query parameters
|
|
222
224
|
query_params = opts[:query_params] || {}
|
|
223
225
|
query_params[:'filters[]'] = @api_client.build_collection_param(opts[:'filters'], :multi) if !opts[:'filters'].nil?
|
|
226
|
+
query_params[:'timestamp'] = opts[:'timestamp'] if !opts[:'timestamp'].nil?
|
|
224
227
|
|
|
225
228
|
# header parameters
|
|
226
229
|
header_params = opts[:header_params] || {}
|