wsc_sdk 1.3.1
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 +7 -0
- data/.circleci/config.yml +146 -0
- data/.circleci/docker/build/Dockerfile +3 -0
- data/.circleci/helpers/add_preamble.rb +29 -0
- data/.circleci/helpers/build_docs.sh +5 -0
- data/.circleci/helpers/build_gem.sh +5 -0
- data/.circleci/helpers/debundle-context.sh +14 -0
- data/.circleci/helpers/finalize_release.sh +24 -0
- data/.circleci/helpers/publish_docs.sh +10 -0
- data/.circleci/helpers/release_gem.sh +8 -0
- data/.circleci/helpers/setup.sh +11 -0
- data/.circleci/helpers/setup_aws.sh +13 -0
- data/.circleci/helpers/setup_gem.sh +2 -0
- data/.circleci/helpers/setup_git.sh +27 -0
- data/.circleci/helpers/setup_rubygems.sh +15 -0
- data/.circleci/helpers/test_integration.sh +12 -0
- data/.circleci/helpers/test_unit.sh +6 -0
- data/.circleci/jobs/publish-production.sh +17 -0
- data/.circleci/jobs/publish-staging.sh +17 -0
- data/.circleci/jobs/release-production.sh +21 -0
- data/.circleci/jobs/test-integration.sh +9 -0
- data/.circleci/jobs/test-unit.sh +9 -0
- data/.circleci/tag_repo.rb +46 -0
- data/.gitignore +28 -0
- data/.rspec +2 -0
- data/.yard/config +2 -0
- data/.yard/template/default/fulldoc/html/css/custom.css +151 -0
- data/.yard/template/default/layout/html/footer.erb +0 -0
- data/.yard/template/default/layout/html/headers.erb +10 -0
- data/.yard/template/default/layout/html/layout.erb +45 -0
- data/.yard/template/default/layout/html/setup.rb +24 -0
- data/.yardopts +1 -0
- data/CODE_OF_CONDUCT.md +74 -0
- data/Gemfile +6 -0
- data/Gemfile.lock +99 -0
- data/LICENSE.txt +28 -0
- data/README.md +397 -0
- data/Rakefile +2 -0
- data/bin/console +14 -0
- data/bin/setup +8 -0
- data/doc/Hash.html +291 -0
- data/doc/WscSdk.html +570 -0
- data/doc/WscSdk/ApiResponse.html +242 -0
- data/doc/WscSdk/Attributes.html +128 -0
- data/doc/WscSdk/Attributes/Mode.html +191 -0
- data/doc/WscSdk/Attributes/Type.html +389 -0
- data/doc/WscSdk/Client.html +2677 -0
- data/doc/WscSdk/Configuration.html +595 -0
- data/doc/WscSdk/Endpoint.html +2974 -0
- data/doc/WscSdk/Endpoints.html +141 -0
- data/doc/WscSdk/Endpoints/CustomStreamTargets.html +383 -0
- data/doc/WscSdk/Endpoints/LiveStreams.html +197 -0
- data/doc/WscSdk/Endpoints/OutputStreamTargets.html +180 -0
- data/doc/WscSdk/Endpoints/Outputs.html +180 -0
- data/doc/WscSdk/Endpoints/StreamTargets.html +446 -0
- data/doc/WscSdk/Endpoints/Transcoders.html +197 -0
- data/doc/WscSdk/Endpoints/UllStreamTargets.html +383 -0
- data/doc/WscSdk/Endpoints/WowzaStreamTargets.html +383 -0
- data/doc/WscSdk/Enum.html +225 -0
- data/doc/WscSdk/Enums.html +321 -0
- data/doc/WscSdk/Enums/BillingMode.html +188 -0
- data/doc/WscSdk/Enums/BroadcastLocation.html +396 -0
- data/doc/WscSdk/Enums/BufferSize.html +301 -0
- data/doc/WscSdk/Enums/ClosedCaptionType.html +221 -0
- data/doc/WscSdk/Enums/CustomProvider.html +252 -0
- data/doc/WscSdk/Enums/DeliveryMethod.html +188 -0
- data/doc/WscSdk/Enums/DeliveryType.html +188 -0
- data/doc/WscSdk/Enums/Encoder.html +460 -0
- data/doc/WscSdk/Enums/Errors.html +555 -0
- data/doc/WscSdk/Enums/IdleTimeout.html +398 -0
- data/doc/WscSdk/Enums/ImagePosition.html +220 -0
- data/doc/WscSdk/Enums/ModelMode.html +175 -0
- data/doc/WscSdk/Enums/ModelType.html +373 -0
- data/doc/WscSdk/Enums/PlayerType.html +188 -0
- data/doc/WscSdk/Enums/Protocol.html +204 -0
- data/doc/WscSdk/Enums/TargetDeliveryProtocol.html +188 -0
- data/doc/WscSdk/Enums/TranscoderType.html +188 -0
- data/doc/WscSdk/Enums/UserRegion.html +383 -0
- data/doc/WscSdk/Enums/WowzaProvider.html +188 -0
- data/doc/WscSdk/Errors.html +683 -0
- data/doc/WscSdk/Loggable.html +346 -0
- data/doc/WscSdk/Model.html +3316 -0
- data/doc/WscSdk/ModelList.html +442 -0
- data/doc/WscSdk/ModelTemplate.html +267 -0
- data/doc/WscSdk/Models.html +141 -0
- data/doc/WscSdk/Models/CustomStreamTarget.html +192 -0
- data/doc/WscSdk/Models/Error.html +351 -0
- data/doc/WscSdk/Models/LiveStream.html +601 -0
- data/doc/WscSdk/Models/LiveStreamConnectionCode.html +192 -0
- data/doc/WscSdk/Models/LiveStreamState.html +200 -0
- data/doc/WscSdk/Models/LiveStreamStats.html +200 -0
- data/doc/WscSdk/Models/LiveStreamThumbnailUrl.html +200 -0
- data/doc/WscSdk/Models/Output.html +294 -0
- data/doc/WscSdk/Models/OutputStreamTarget.html +274 -0
- data/doc/WscSdk/Models/StreamTarget.html +273 -0
- data/doc/WscSdk/Models/Transcoder.html +793 -0
- data/doc/WscSdk/Models/TranscoderBooleanStat.html +278 -0
- data/doc/WscSdk/Models/TranscoderConnectionCode.html +192 -0
- data/doc/WscSdk/Models/TranscoderFloatStat.html +278 -0
- data/doc/WscSdk/Models/TranscoderIntegerStat.html +278 -0
- data/doc/WscSdk/Models/TranscoderState.html +196 -0
- data/doc/WscSdk/Models/TranscoderStats.html +196 -0
- data/doc/WscSdk/Models/TranscoderStreamTargetState.html +192 -0
- data/doc/WscSdk/Models/TranscoderStringStat.html +278 -0
- data/doc/WscSdk/Models/TranscoderThumbnailUrl.html +196 -0
- data/doc/WscSdk/Models/UllStreamTarget.html +360 -0
- data/doc/WscSdk/Models/WowzaStreamTarget.html +380 -0
- data/doc/WscSdk/Pagination.html +1277 -0
- data/doc/WscSdk/Schema.html +861 -0
- data/doc/WscSdk/SchemaAttribute.html +2400 -0
- data/doc/WscSdk/Templates.html +141 -0
- data/doc/WscSdk/Templates/CustomStreamTarget.html +1045 -0
- data/doc/WscSdk/Templates/LiveStream.html +1432 -0
- data/doc/WscSdk/Templates/Output.html +829 -0
- data/doc/WscSdk/Templates/Transcoder.html +699 -0
- data/doc/WscSdk/Templates/UllStreamTarget.html +411 -0
- data/doc/WscSdk/Templates/WowzaStreamTarget.html +447 -0
- data/doc/WscSdk/TranscoderSharedMethods.html +1113 -0
- data/doc/_index.html +705 -0
- data/doc/class_list.html +51 -0
- data/doc/css/bootstrap.css +5 -0
- data/doc/css/common.css +1 -0
- data/doc/css/custom.css +151 -0
- data/doc/css/full_list.css +58 -0
- data/doc/css/style.css +496 -0
- data/doc/file.README.html +570 -0
- data/doc/file_list.html +56 -0
- data/doc/frames.html +17 -0
- data/doc/images/wsc-ruby-1800x400.png +0 -0
- data/doc/index.html +570 -0
- data/doc/js/app.js +292 -0
- data/doc/js/full_list.js +216 -0
- data/doc/js/jquery.js +4 -0
- data/doc/method_list.html +1731 -0
- data/doc/top-level-namespace.html +182 -0
- data/examples/client.rb +40 -0
- data/examples/helpers.rb +100 -0
- data/examples/live_streams/create.rb +39 -0
- data/examples/live_streams/delete.rb +32 -0
- data/examples/live_streams/find.rb +22 -0
- data/examples/live_streams/flood.rb +126 -0
- data/examples/live_streams/list.rb +24 -0
- data/examples/live_streams/regenerate_connection_code.rb +29 -0
- data/examples/live_streams/reset.rb +32 -0
- data/examples/live_streams/reset_and_wait.rb +51 -0
- data/examples/live_streams/start.rb +33 -0
- data/examples/live_streams/start_and_wait.rb +51 -0
- data/examples/live_streams/state.rb +33 -0
- data/examples/live_streams/stats.rb +43 -0
- data/examples/live_streams/stop.rb +33 -0
- data/examples/live_streams/stop_and_wait.rb +51 -0
- data/examples/live_streams/thumbnail_url.rb +46 -0
- data/examples/live_streams/update.rb +43 -0
- data/examples/live_streams/workflow.rb +165 -0
- data/examples/output_stream_targets/create.rb +56 -0
- data/examples/output_stream_targets/delete.rb +45 -0
- data/examples/output_stream_targets/find.rb +37 -0
- data/examples/output_stream_targets/list.rb +36 -0
- data/examples/output_stream_targets/update.rb +56 -0
- data/examples/outputs/create.rb +49 -0
- data/examples/outputs/delete.rb +39 -0
- data/examples/outputs/find.rb +31 -0
- data/examples/outputs/list.rb +29 -0
- data/examples/outputs/update.rb +50 -0
- data/examples/stream_targets/custom/create.rb +42 -0
- data/examples/stream_targets/custom/delete.rb +31 -0
- data/examples/stream_targets/custom/find.rb +23 -0
- data/examples/stream_targets/custom/list.rb +24 -0
- data/examples/stream_targets/custom/update.rb +43 -0
- data/examples/stream_targets/list.rb +24 -0
- data/examples/stream_targets/ull/create.rb +41 -0
- data/examples/stream_targets/ull/delete.rb +31 -0
- data/examples/stream_targets/ull/find.rb +23 -0
- data/examples/stream_targets/ull/list.rb +24 -0
- data/examples/stream_targets/ull/update.rb +43 -0
- data/examples/stream_targets/wowza/create.rb +42 -0
- data/examples/stream_targets/wowza/delete.rb +31 -0
- data/examples/stream_targets/wowza/find.rb +23 -0
- data/examples/stream_targets/wowza/list.rb +23 -0
- data/examples/stream_targets/wowza/update.rb +43 -0
- data/examples/transcoders/create.rb +39 -0
- data/examples/transcoders/delete.rb +31 -0
- data/examples/transcoders/find.rb +23 -0
- data/examples/transcoders/list.rb +24 -0
- data/examples/transcoders/reset.rb +32 -0
- data/examples/transcoders/reset_and_wait.rb +48 -0
- data/examples/transcoders/start.rb +33 -0
- data/examples/transcoders/start_and_wait.rb +50 -0
- data/examples/transcoders/state.rb +33 -0
- data/examples/transcoders/stats.rb +43 -0
- data/examples/transcoders/stop.rb +33 -0
- data/examples/transcoders/stop_and_wait.rb +50 -0
- data/examples/transcoders/thumbnail_url.rb +46 -0
- data/examples/transcoders/update.rb +43 -0
- data/images/wsc-ruby-1800x400.png +0 -0
- data/lib/wsc_sdk.rb +81 -0
- data/lib/wsc_sdk/client.rb +417 -0
- data/lib/wsc_sdk/configuration.rb +21 -0
- data/lib/wsc_sdk/constants.rb +29 -0
- data/lib/wsc_sdk/endpoint.rb +492 -0
- data/lib/wsc_sdk/endpoints/custom_stream_targets.rb +44 -0
- data/lib/wsc_sdk/endpoints/live_streams.rb +34 -0
- data/lib/wsc_sdk/endpoints/output_stream_targets.rb +17 -0
- data/lib/wsc_sdk/endpoints/outputs.rb +17 -0
- data/lib/wsc_sdk/endpoints/stream_targets.rb +45 -0
- data/lib/wsc_sdk/endpoints/transcoders.rb +38 -0
- data/lib/wsc_sdk/endpoints/ull_stream_targets.rb +44 -0
- data/lib/wsc_sdk/endpoints/wowza_stream_targets.rb +44 -0
- data/lib/wsc_sdk/enums.rb +31 -0
- data/lib/wsc_sdk/enums/billing_mode.rb +20 -0
- data/lib/wsc_sdk/enums/broadcast_location.rb +58 -0
- data/lib/wsc_sdk/enums/buffer_size.rb +41 -0
- data/lib/wsc_sdk/enums/closed_caption_type.rb +26 -0
- data/lib/wsc_sdk/enums/custom_provider.rb +32 -0
- data/lib/wsc_sdk/enums/delivery_method.rb +20 -0
- data/lib/wsc_sdk/enums/delivery_type.rb +20 -0
- data/lib/wsc_sdk/enums/encoder.rb +71 -0
- data/lib/wsc_sdk/enums/idle_timeout.rb +50 -0
- data/lib/wsc_sdk/enums/image_position.rb +26 -0
- data/lib/wsc_sdk/enums/player_type.rb +20 -0
- data/lib/wsc_sdk/enums/protocol.rb +23 -0
- data/lib/wsc_sdk/enums/target_delivery_protocol.rb +20 -0
- data/lib/wsc_sdk/enums/transcoder_type.rb +20 -0
- data/lib/wsc_sdk/enums/wowza_provider.rb +20 -0
- data/lib/wsc_sdk/errors.rb +115 -0
- data/lib/wsc_sdk/model.rb +515 -0
- data/lib/wsc_sdk/model_list.rb +42 -0
- data/lib/wsc_sdk/model_template.rb +27 -0
- data/lib/wsc_sdk/models/custom_stream_target.rb +34 -0
- data/lib/wsc_sdk/models/error.rb +53 -0
- data/lib/wsc_sdk/models/live_stream.rb +130 -0
- data/lib/wsc_sdk/models/live_stream_connection_code.rb +31 -0
- data/lib/wsc_sdk/models/live_stream_state.rb +20 -0
- data/lib/wsc_sdk/models/live_stream_stats.rb +20 -0
- data/lib/wsc_sdk/models/live_stream_thumbnail_url.rb +20 -0
- data/lib/wsc_sdk/models/output.rb +61 -0
- data/lib/wsc_sdk/models/output_stream_target.rb +37 -0
- data/lib/wsc_sdk/models/stream_target.rb +29 -0
- data/lib/wsc_sdk/models/transcoder.rb +135 -0
- data/lib/wsc_sdk/models/transcoder_boolean_stat.rb +41 -0
- data/lib/wsc_sdk/models/transcoder_connection_code.rb +29 -0
- data/lib/wsc_sdk/models/transcoder_float_stat.rb +40 -0
- data/lib/wsc_sdk/models/transcoder_integer_stat.rb +40 -0
- data/lib/wsc_sdk/models/transcoder_state.rb +31 -0
- data/lib/wsc_sdk/models/transcoder_stats.rb +51 -0
- data/lib/wsc_sdk/models/transcoder_stream_target_state.rb +29 -0
- data/lib/wsc_sdk/models/transcoder_string_stat.rb +40 -0
- data/lib/wsc_sdk/models/transcoder_thumbnail_url.rb +29 -0
- data/lib/wsc_sdk/models/ull_stream_target.rb +54 -0
- data/lib/wsc_sdk/models/wowza_stream_target.rb +60 -0
- data/lib/wsc_sdk/modules/api_response.rb +24 -0
- data/lib/wsc_sdk/modules/loggable.rb +44 -0
- data/lib/wsc_sdk/modules/transcoder_shared_methods.rb +221 -0
- data/lib/wsc_sdk/pagination.rb +89 -0
- data/lib/wsc_sdk/schema.rb +140 -0
- data/lib/wsc_sdk/schema_attribute.rb +349 -0
- data/lib/wsc_sdk/templates/custom_stream_target.rb +154 -0
- data/lib/wsc_sdk/templates/live_stream.rb +234 -0
- data/lib/wsc_sdk/templates/output.rb +133 -0
- data/lib/wsc_sdk/templates/transcoder.rb +97 -0
- data/lib/wsc_sdk/templates/ull_stream_target.rb +49 -0
- data/lib/wsc_sdk/templates/wowza_stream_target.rb +57 -0
- data/lib/wsc_sdk/version.rb +7 -0
- data/wsc_sdk.gemspec +48 -0
- metadata +460 -0
|
@@ -0,0 +1,188 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
<html>
|
|
3
|
+
<head>
|
|
4
|
+
<meta charset="utf-8">
|
|
5
|
+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
6
|
+
<title>Wowza Streaming Cloud - SDK Code Documentation</title>
|
|
7
|
+
|
|
8
|
+
<link rel="stylesheet" href="../../css/style.css" type="text/css" charset="utf-8" />
|
|
9
|
+
|
|
10
|
+
<link rel="stylesheet" href="../../css/common.css" type="text/css" charset="utf-8" />
|
|
11
|
+
|
|
12
|
+
<link rel="stylesheet" href="../../css/custom.css" type="text/css" charset="utf-8" />
|
|
13
|
+
|
|
14
|
+
<script type="text/javascript" charset="utf-8">
|
|
15
|
+
pathId = "WscSdk::Enums::WowzaProvider";
|
|
16
|
+
relpath = '../../';
|
|
17
|
+
</script>
|
|
18
|
+
|
|
19
|
+
|
|
20
|
+
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
|
|
21
|
+
|
|
22
|
+
<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
|
|
23
|
+
|
|
24
|
+
|
|
25
|
+
</head>
|
|
26
|
+
<body>
|
|
27
|
+
<div id="wowza-wrapper">
|
|
28
|
+
<header>
|
|
29
|
+
<div class="logo">
|
|
30
|
+
<a href="https://www.wowza.com">
|
|
31
|
+
<img src="https://cloud.wowza.com/apidocs/assets/logo.png" alt="Wowza Logo" />
|
|
32
|
+
</a>
|
|
33
|
+
<h1>Wowza Streaming Cloud<br/>SDK Code Documentation</h1>
|
|
34
|
+
<div class="clearfix"></div>
|
|
35
|
+
</div>
|
|
36
|
+
<div class="links">
|
|
37
|
+
<a href="https://www.wowza.com/">Wowza Home</a>
|
|
38
|
+
<a href="https://www.wowza.com/docs">Docs & APIS</a>
|
|
39
|
+
<a href="https://www.wowza.com/community/index.html">Forums</a>
|
|
40
|
+
<a href="https://www.wowza.com/support">Support</a>
|
|
41
|
+
</div>
|
|
42
|
+
<div class="clearfix"></div>
|
|
43
|
+
</header>
|
|
44
|
+
|
|
45
|
+
<div id="content">
|
|
46
|
+
<div class="nav_wrap">
|
|
47
|
+
<iframe id="nav" src="../../class_list.html?1"></iframe>
|
|
48
|
+
<div id="resizer"></div>
|
|
49
|
+
</div>
|
|
50
|
+
|
|
51
|
+
<div id="main" tabindex="-1">
|
|
52
|
+
<div id="header">
|
|
53
|
+
<div id="menu">
|
|
54
|
+
|
|
55
|
+
<a href="../../_index.html">Index (W)</a> »
|
|
56
|
+
<span class='title'><span class='object_link'><a href="../../WscSdk.html" title="WscSdk (module)">WscSdk</a></span></span> » <span class='title'><span class='object_link'><a href="../Enums.html" title="WscSdk::Enums (module)">Enums</a></span></span>
|
|
57
|
+
»
|
|
58
|
+
<span class="title">WowzaProvider</span>
|
|
59
|
+
|
|
60
|
+
</div>
|
|
61
|
+
|
|
62
|
+
<div id="search">
|
|
63
|
+
|
|
64
|
+
<a class="full_list_link" id="class_list_link"
|
|
65
|
+
href="../../class_list.html">
|
|
66
|
+
|
|
67
|
+
<svg width="24" height="24">
|
|
68
|
+
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
|
|
69
|
+
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
|
|
70
|
+
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
|
|
71
|
+
</svg>
|
|
72
|
+
</a>
|
|
73
|
+
|
|
74
|
+
</div>
|
|
75
|
+
<div class="clear"></div>
|
|
76
|
+
</div>
|
|
77
|
+
|
|
78
|
+
<div id="content"><h1>Module: WscSdk::Enums::WowzaProvider
|
|
79
|
+
|
|
80
|
+
|
|
81
|
+
|
|
82
|
+
</h1>
|
|
83
|
+
<div class="box_info">
|
|
84
|
+
|
|
85
|
+
|
|
86
|
+
|
|
87
|
+
|
|
88
|
+
<dl>
|
|
89
|
+
<dt>Extended by:</dt>
|
|
90
|
+
<dd><span class='object_link'><a href="../Enums.html" title="WscSdk::Enums (module)">WscSdk::Enums</a></span></dd>
|
|
91
|
+
</dl>
|
|
92
|
+
|
|
93
|
+
|
|
94
|
+
|
|
95
|
+
|
|
96
|
+
|
|
97
|
+
|
|
98
|
+
|
|
99
|
+
|
|
100
|
+
<dl>
|
|
101
|
+
<dt>Defined in:</dt>
|
|
102
|
+
<dd>lib/wsc_sdk/enums/wowza_provider.rb</dd>
|
|
103
|
+
</dl>
|
|
104
|
+
|
|
105
|
+
</div>
|
|
106
|
+
|
|
107
|
+
<h2>Overview</h2><div class="docstring">
|
|
108
|
+
<div class="discussion">
|
|
109
|
+
|
|
110
|
+
<p>Enumerate valid transcoder types.</p>
|
|
111
|
+
|
|
112
|
+
|
|
113
|
+
</div>
|
|
114
|
+
</div>
|
|
115
|
+
<div class="tags">
|
|
116
|
+
|
|
117
|
+
|
|
118
|
+
</div>
|
|
119
|
+
|
|
120
|
+
<h2>
|
|
121
|
+
Constant Summary
|
|
122
|
+
<small><a href="#" class="constants_summary_toggle">collapse</a></small>
|
|
123
|
+
</h2>
|
|
124
|
+
|
|
125
|
+
<dl class="constants">
|
|
126
|
+
|
|
127
|
+
<dt id="AKAMAI-constant" class="">AKAMAI =
|
|
128
|
+
<div class="docstring">
|
|
129
|
+
<div class="discussion">
|
|
130
|
+
|
|
131
|
+
<p>Akamai Wowza Provider</p>
|
|
132
|
+
|
|
133
|
+
|
|
134
|
+
</div>
|
|
135
|
+
</div>
|
|
136
|
+
<div class="tags">
|
|
137
|
+
|
|
138
|
+
|
|
139
|
+
</div>
|
|
140
|
+
</dt>
|
|
141
|
+
<dd><pre class="code"><span style="background-color:hsla(0,100%,50%,0.05)"><span style="color:#710">"</span><span style="color:#D20">akamai</span><span style="color:#710">"</span></span></pre></dd>
|
|
142
|
+
|
|
143
|
+
<dt id="AKAMAI_CUPERTINO-constant" class="">AKAMAI_CUPERTINO =
|
|
144
|
+
<div class="docstring">
|
|
145
|
+
<div class="discussion">
|
|
146
|
+
|
|
147
|
+
<p>Akamai Cupertino Wowza Provider</p>
|
|
148
|
+
|
|
149
|
+
|
|
150
|
+
</div>
|
|
151
|
+
</div>
|
|
152
|
+
<div class="tags">
|
|
153
|
+
|
|
154
|
+
|
|
155
|
+
</div>
|
|
156
|
+
</dt>
|
|
157
|
+
<dd><pre class="code"><span style="background-color:hsla(0,100%,50%,0.05)"><span style="color:#710">"</span><span style="color:#D20">akamai_cupertino</span><span style="color:#710">"</span></span></pre></dd>
|
|
158
|
+
|
|
159
|
+
</dl>
|
|
160
|
+
|
|
161
|
+
|
|
162
|
+
|
|
163
|
+
|
|
164
|
+
|
|
165
|
+
|
|
166
|
+
|
|
167
|
+
|
|
168
|
+
|
|
169
|
+
|
|
170
|
+
|
|
171
|
+
|
|
172
|
+
|
|
173
|
+
|
|
174
|
+
|
|
175
|
+
<h2>Method Summary</h2>
|
|
176
|
+
|
|
177
|
+
<h3 class="inherited">Methods included from <span class='object_link'><a href="../Enums.html" title="WscSdk::Enums (module)">WscSdk::Enums</a></span></h3>
|
|
178
|
+
<p class="inherited"><span class='object_link'><a href="../Enums.html#to_constant-instance_method" title="WscSdk::Enums#to_constant (method)">to_constant</a></span>, <span class='object_link'><a href="../Enums.html#values-instance_method" title="WscSdk::Enums#values (method)">values</a></span></p>
|
|
179
|
+
|
|
180
|
+
|
|
181
|
+
</div>
|
|
182
|
+
|
|
183
|
+
|
|
184
|
+
</div>
|
|
185
|
+
</div>
|
|
186
|
+
</div>
|
|
187
|
+
</body>
|
|
188
|
+
</html>
|
|
@@ -0,0 +1,683 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
<html>
|
|
3
|
+
<head>
|
|
4
|
+
<meta charset="utf-8">
|
|
5
|
+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
6
|
+
<title>Wowza Streaming Cloud - SDK Code Documentation</title>
|
|
7
|
+
|
|
8
|
+
<link rel="stylesheet" href="../css/style.css" type="text/css" charset="utf-8" />
|
|
9
|
+
|
|
10
|
+
<link rel="stylesheet" href="../css/common.css" type="text/css" charset="utf-8" />
|
|
11
|
+
|
|
12
|
+
<link rel="stylesheet" href="../css/custom.css" type="text/css" charset="utf-8" />
|
|
13
|
+
|
|
14
|
+
<script type="text/javascript" charset="utf-8">
|
|
15
|
+
pathId = "WscSdk::Errors";
|
|
16
|
+
relpath = '../';
|
|
17
|
+
</script>
|
|
18
|
+
|
|
19
|
+
|
|
20
|
+
<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
|
|
21
|
+
|
|
22
|
+
<script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
|
|
23
|
+
|
|
24
|
+
|
|
25
|
+
</head>
|
|
26
|
+
<body>
|
|
27
|
+
<div id="wowza-wrapper">
|
|
28
|
+
<header>
|
|
29
|
+
<div class="logo">
|
|
30
|
+
<a href="https://www.wowza.com">
|
|
31
|
+
<img src="https://cloud.wowza.com/apidocs/assets/logo.png" alt="Wowza Logo" />
|
|
32
|
+
</a>
|
|
33
|
+
<h1>Wowza Streaming Cloud<br/>SDK Code Documentation</h1>
|
|
34
|
+
<div class="clearfix"></div>
|
|
35
|
+
</div>
|
|
36
|
+
<div class="links">
|
|
37
|
+
<a href="https://www.wowza.com/">Wowza Home</a>
|
|
38
|
+
<a href="https://www.wowza.com/docs">Docs & APIS</a>
|
|
39
|
+
<a href="https://www.wowza.com/community/index.html">Forums</a>
|
|
40
|
+
<a href="https://www.wowza.com/support">Support</a>
|
|
41
|
+
</div>
|
|
42
|
+
<div class="clearfix"></div>
|
|
43
|
+
</header>
|
|
44
|
+
|
|
45
|
+
<div id="content">
|
|
46
|
+
<div class="nav_wrap">
|
|
47
|
+
<iframe id="nav" src="../class_list.html?1"></iframe>
|
|
48
|
+
<div id="resizer"></div>
|
|
49
|
+
</div>
|
|
50
|
+
|
|
51
|
+
<div id="main" tabindex="-1">
|
|
52
|
+
<div id="header">
|
|
53
|
+
<div id="menu">
|
|
54
|
+
|
|
55
|
+
<a href="../_index.html">Index (E)</a> »
|
|
56
|
+
<span class='title'><span class='object_link'><a href="../WscSdk.html" title="WscSdk (module)">WscSdk</a></span></span>
|
|
57
|
+
»
|
|
58
|
+
<span class="title">Errors</span>
|
|
59
|
+
|
|
60
|
+
</div>
|
|
61
|
+
|
|
62
|
+
<div id="search">
|
|
63
|
+
|
|
64
|
+
<a class="full_list_link" id="class_list_link"
|
|
65
|
+
href="../class_list.html">
|
|
66
|
+
|
|
67
|
+
<svg width="24" height="24">
|
|
68
|
+
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
|
|
69
|
+
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
|
|
70
|
+
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
|
|
71
|
+
</svg>
|
|
72
|
+
</a>
|
|
73
|
+
|
|
74
|
+
</div>
|
|
75
|
+
<div class="clear"></div>
|
|
76
|
+
</div>
|
|
77
|
+
|
|
78
|
+
<div id="content"><h1>Module: WscSdk::Errors
|
|
79
|
+
|
|
80
|
+
|
|
81
|
+
|
|
82
|
+
</h1>
|
|
83
|
+
<div class="box_info">
|
|
84
|
+
|
|
85
|
+
|
|
86
|
+
|
|
87
|
+
|
|
88
|
+
|
|
89
|
+
|
|
90
|
+
|
|
91
|
+
|
|
92
|
+
|
|
93
|
+
|
|
94
|
+
|
|
95
|
+
<dl>
|
|
96
|
+
<dt>Defined in:</dt>
|
|
97
|
+
<dd>lib/wsc_sdk/errors.rb</dd>
|
|
98
|
+
</dl>
|
|
99
|
+
|
|
100
|
+
</div>
|
|
101
|
+
|
|
102
|
+
<h2>Overview</h2><div class="docstring">
|
|
103
|
+
<div class="discussion">
|
|
104
|
+
|
|
105
|
+
<p>Enumerate the errors that can be generated by the SDK</p>
|
|
106
|
+
|
|
107
|
+
|
|
108
|
+
</div>
|
|
109
|
+
</div>
|
|
110
|
+
<div class="tags">
|
|
111
|
+
|
|
112
|
+
|
|
113
|
+
</div>
|
|
114
|
+
|
|
115
|
+
<h2>
|
|
116
|
+
Constant Summary
|
|
117
|
+
<small><a href="#" class="constants_summary_toggle">collapse</a></small>
|
|
118
|
+
</h2>
|
|
119
|
+
|
|
120
|
+
<dl class="constants">
|
|
121
|
+
|
|
122
|
+
<dt id="INVALID_ATTRIBUTES-constant" class="">INVALID_ATTRIBUTES =
|
|
123
|
+
<div class="docstring">
|
|
124
|
+
<div class="discussion">
|
|
125
|
+
|
|
126
|
+
<p>Error returned when the model does not validate.</p>
|
|
127
|
+
|
|
128
|
+
|
|
129
|
+
</div>
|
|
130
|
+
</div>
|
|
131
|
+
<div class="tags">
|
|
132
|
+
|
|
133
|
+
|
|
134
|
+
</div>
|
|
135
|
+
</dt>
|
|
136
|
+
<dd><pre class="code">{
|
|
137
|
+
<span style="color:#606">meta</span>: {
|
|
138
|
+
<span style="color:#606">status</span>: <span style="color:#00D">422</span>,
|
|
139
|
+
<span style="color:#606">code</span>: <span style="background-color:hsla(0,100%,50%,0.05)"><span style="color:#710">"</span><span style="color:#D20">ERR-422-InvalidAttributes</span><span style="color:#710">"</span></span>,
|
|
140
|
+
<span style="color:#606">title</span>: <span style="background-color:hsla(0,100%,50%,0.05)"><span style="color:#710">"</span><span style="color:#D20">Invalid Attributes</span><span style="color:#710">"</span></span>,
|
|
141
|
+
<span style="color:#606">message</span>: <span style="background-color:hsla(0,100%,50%,0.05)"><span style="color:#710">"</span><span style="color:#D20">The model has invalid attribute values assigned to it. Check the `WscSdk::Model#errors` property for more details.</span><span style="color:#710">"</span></span>,
|
|
142
|
+
<span style="color:#606">description</span>: <span style="background-color:hsla(0,100%,50%,0.05)"><span style="color:#710">"</span><span style="color:#710">"</span></span>
|
|
143
|
+
}
|
|
144
|
+
}</pre></dd>
|
|
145
|
+
|
|
146
|
+
<dt id="INVALID_PAYLOAD-constant" class="">INVALID_PAYLOAD =
|
|
147
|
+
<div class="docstring">
|
|
148
|
+
<div class="discussion">
|
|
149
|
+
|
|
150
|
+
<p>Error returned if the data returned from the API is not valid JSON.</p>
|
|
151
|
+
|
|
152
|
+
|
|
153
|
+
</div>
|
|
154
|
+
</div>
|
|
155
|
+
<div class="tags">
|
|
156
|
+
|
|
157
|
+
|
|
158
|
+
</div>
|
|
159
|
+
</dt>
|
|
160
|
+
<dd><pre class="code">{
|
|
161
|
+
<span style="color:#606">meta</span>: {
|
|
162
|
+
<span style="color:#606">status</span>: <span style="color:#00D">422</span>,
|
|
163
|
+
<span style="color:#606">code</span>: <span style="background-color:hsla(0,100%,50%,0.05)"><span style="color:#710">"</span><span style="color:#D20">ERR-422-PayloadInvalid</span><span style="color:#710">"</span></span>,
|
|
164
|
+
<span style="color:#606">title</span>: <span style="background-color:hsla(0,100%,50%,0.05)"><span style="color:#710">"</span><span style="color:#D20">Payload Invalid</span><span style="color:#710">"</span></span>,
|
|
165
|
+
<span style="color:#606">message</span>: <span style="background-color:hsla(0,100%,50%,0.05)"><span style="color:#710">"</span><span style="color:#D20">The API request received an invalid payload.</span><span style="color:#710">"</span></span>,
|
|
166
|
+
<span style="color:#606">description</span>: <span style="background-color:hsla(0,100%,50%,0.05)"><span style="color:#710">"</span><span style="color:#D20">Turn on logging in DEBUG mode for more details about the issue.</span><span style="color:#710">"</span></span>
|
|
167
|
+
}
|
|
168
|
+
}</pre></dd>
|
|
169
|
+
|
|
170
|
+
<dt id="MODEL_DOES_NOT_EXIST-constant" class="">MODEL_DOES_NOT_EXIST =
|
|
171
|
+
<div class="docstring">
|
|
172
|
+
<div class="discussion">
|
|
173
|
+
|
|
174
|
+
<p>Error returned when the model is attempting an update, but it doesn't
|
|
175
|
+
have a primary key.</p>
|
|
176
|
+
|
|
177
|
+
|
|
178
|
+
</div>
|
|
179
|
+
</div>
|
|
180
|
+
<div class="tags">
|
|
181
|
+
|
|
182
|
+
|
|
183
|
+
</div>
|
|
184
|
+
</dt>
|
|
185
|
+
<dd><pre class="code">{
|
|
186
|
+
<span style="color:#606">meta</span>: {
|
|
187
|
+
<span style="color:#606">status</span>: <span style="color:#00D">422</span>,
|
|
188
|
+
<span style="color:#606">code</span>: <span style="background-color:hsla(0,100%,50%,0.05)"><span style="color:#710">"</span><span style="color:#D20">ERR-422-ModelDoesNotExist</span><span style="color:#710">"</span></span>,
|
|
189
|
+
<span style="color:#606">title</span>: <span style="background-color:hsla(0,100%,50%,0.05)"><span style="color:#710">"</span><span style="color:#D20">Model Does Not Exist</span><span style="color:#710">"</span></span>,
|
|
190
|
+
<span style="color:#606">message</span>: <span style="background-color:hsla(0,100%,50%,0.05)"><span style="color:#710">"</span><span style="color:#D20">You are attempting to access or update a record that does not exist yet. Try creating it first.</span><span style="color:#710">"</span></span>,
|
|
191
|
+
<span style="color:#606">description</span>: <span style="background-color:hsla(0,100%,50%,0.05)"><span style="color:#710">"</span><span style="color:#710">"</span></span>
|
|
192
|
+
}
|
|
193
|
+
}</pre></dd>
|
|
194
|
+
|
|
195
|
+
<dt id="MODEL_EXISTS-constant" class="">MODEL_EXISTS =
|
|
196
|
+
<div class="docstring">
|
|
197
|
+
<div class="discussion">
|
|
198
|
+
|
|
199
|
+
<p>Error returned when the model is attempting to create, but it already has a
|
|
200
|
+
primary key.</p>
|
|
201
|
+
|
|
202
|
+
|
|
203
|
+
</div>
|
|
204
|
+
</div>
|
|
205
|
+
<div class="tags">
|
|
206
|
+
|
|
207
|
+
|
|
208
|
+
</div>
|
|
209
|
+
</dt>
|
|
210
|
+
<dd><pre class="code">{
|
|
211
|
+
<span style="color:#606">meta</span>: {
|
|
212
|
+
<span style="color:#606">status</span>: <span style="color:#00D">422</span>,
|
|
213
|
+
<span style="color:#606">code</span>: <span style="background-color:hsla(0,100%,50%,0.05)"><span style="color:#710">"</span><span style="color:#D20">ERR-422-ModelExists</span><span style="color:#710">"</span></span>,
|
|
214
|
+
<span style="color:#606">title</span>: <span style="background-color:hsla(0,100%,50%,0.05)"><span style="color:#710">"</span><span style="color:#D20">Model Exists</span><span style="color:#710">"</span></span>,
|
|
215
|
+
<span style="color:#606">message</span>: <span style="background-color:hsla(0,100%,50%,0.05)"><span style="color:#710">"</span><span style="color:#D20">You are attempting to create a record that already exists. Try updating the it.</span><span style="color:#710">"</span></span>,
|
|
216
|
+
<span style="color:#606">description</span>: <span style="background-color:hsla(0,100%,50%,0.05)"><span style="color:#710">"</span><span style="color:#710">"</span></span>
|
|
217
|
+
}
|
|
218
|
+
}</pre></dd>
|
|
219
|
+
|
|
220
|
+
</dl>
|
|
221
|
+
|
|
222
|
+
|
|
223
|
+
|
|
224
|
+
|
|
225
|
+
|
|
226
|
+
|
|
227
|
+
|
|
228
|
+
|
|
229
|
+
|
|
230
|
+
<h2>
|
|
231
|
+
Class Method Summary
|
|
232
|
+
<small><a href="#" class="summary_toggle">collapse</a></small>
|
|
233
|
+
</h2>
|
|
234
|
+
|
|
235
|
+
<ul class="summary">
|
|
236
|
+
|
|
237
|
+
<li class="public ">
|
|
238
|
+
<span class="summary_signature">
|
|
239
|
+
|
|
240
|
+
<a href="#invalid_attributes-class_method" title="invalid_attributes (class method)">.<strong>invalid_attributes</strong>(endpoint) ⇒ WscSdk::Models::Error </a>
|
|
241
|
+
|
|
242
|
+
|
|
243
|
+
|
|
244
|
+
</span>
|
|
245
|
+
|
|
246
|
+
|
|
247
|
+
|
|
248
|
+
|
|
249
|
+
|
|
250
|
+
|
|
251
|
+
|
|
252
|
+
|
|
253
|
+
|
|
254
|
+
<span class="summary_desc"><div class='inline'>
|
|
255
|
+
<p>Build an INVALID_ATTRIBUTES error model object.</p>
|
|
256
|
+
</div></span>
|
|
257
|
+
|
|
258
|
+
</li>
|
|
259
|
+
|
|
260
|
+
|
|
261
|
+
<li class="public ">
|
|
262
|
+
<span class="summary_signature">
|
|
263
|
+
|
|
264
|
+
<a href="#invalid_payload-class_method" title="invalid_payload (class method)">.<strong>invalid_payload</strong>(endpoint) ⇒ WscSdk::Models::Error </a>
|
|
265
|
+
|
|
266
|
+
|
|
267
|
+
|
|
268
|
+
</span>
|
|
269
|
+
|
|
270
|
+
|
|
271
|
+
|
|
272
|
+
|
|
273
|
+
|
|
274
|
+
|
|
275
|
+
|
|
276
|
+
|
|
277
|
+
|
|
278
|
+
<span class="summary_desc"><div class='inline'>
|
|
279
|
+
<p>Build an INVALID_PAYLOAD error model object.</p>
|
|
280
|
+
</div></span>
|
|
281
|
+
|
|
282
|
+
</li>
|
|
283
|
+
|
|
284
|
+
|
|
285
|
+
<li class="public ">
|
|
286
|
+
<span class="summary_signature">
|
|
287
|
+
|
|
288
|
+
<a href="#model_does_not_exist-class_method" title="model_does_not_exist (class method)">.<strong>model_does_not_exist</strong>(endpoint) ⇒ WscSdk::Models::Error </a>
|
|
289
|
+
|
|
290
|
+
|
|
291
|
+
|
|
292
|
+
</span>
|
|
293
|
+
|
|
294
|
+
|
|
295
|
+
|
|
296
|
+
|
|
297
|
+
|
|
298
|
+
|
|
299
|
+
|
|
300
|
+
|
|
301
|
+
|
|
302
|
+
<span class="summary_desc"><div class='inline'>
|
|
303
|
+
<p>Build an RECORD_DOES_NOT_EXIST error model object.</p>
|
|
304
|
+
</div></span>
|
|
305
|
+
|
|
306
|
+
</li>
|
|
307
|
+
|
|
308
|
+
|
|
309
|
+
<li class="public ">
|
|
310
|
+
<span class="summary_signature">
|
|
311
|
+
|
|
312
|
+
<a href="#model_exists-class_method" title="model_exists (class method)">.<strong>model_exists</strong>(endpoint) ⇒ WscSdk::Models::Error </a>
|
|
313
|
+
|
|
314
|
+
|
|
315
|
+
|
|
316
|
+
</span>
|
|
317
|
+
|
|
318
|
+
|
|
319
|
+
|
|
320
|
+
|
|
321
|
+
|
|
322
|
+
|
|
323
|
+
|
|
324
|
+
|
|
325
|
+
|
|
326
|
+
<span class="summary_desc"><div class='inline'>
|
|
327
|
+
<p>Build an RECORD_EXISTS error model object.</p>
|
|
328
|
+
</div></span>
|
|
329
|
+
|
|
330
|
+
</li>
|
|
331
|
+
|
|
332
|
+
|
|
333
|
+
</ul>
|
|
334
|
+
|
|
335
|
+
|
|
336
|
+
|
|
337
|
+
|
|
338
|
+
<div id="class_method_details" class="method_details_list">
|
|
339
|
+
<h2>Class Method Details</h2>
|
|
340
|
+
|
|
341
|
+
|
|
342
|
+
<div class="method_details first">
|
|
343
|
+
<h3 class="signature first" id="invalid_attributes-class_method">
|
|
344
|
+
|
|
345
|
+
.<strong>invalid_attributes</strong>(endpoint) ⇒ <tt><span class='object_link'><a href="Models/Error.html" title="WscSdk::Models::Error (class)">WscSdk::Models::Error</a></span></tt>
|
|
346
|
+
|
|
347
|
+
|
|
348
|
+
|
|
349
|
+
|
|
350
|
+
|
|
351
|
+
</h3><div class="docstring">
|
|
352
|
+
<div class="discussion">
|
|
353
|
+
|
|
354
|
+
<p>Build an INVALID_ATTRIBUTES error model object.</p>
|
|
355
|
+
|
|
356
|
+
|
|
357
|
+
</div>
|
|
358
|
+
</div>
|
|
359
|
+
<div class="tags">
|
|
360
|
+
<p class="tag_title">Parameters:</p>
|
|
361
|
+
<ul class="param">
|
|
362
|
+
|
|
363
|
+
<li>
|
|
364
|
+
|
|
365
|
+
<span class='name'>endpoint</span>
|
|
366
|
+
|
|
367
|
+
|
|
368
|
+
<span class='type'>(<tt><span class='object_link'><a href="Endpoint.html" title="WscSdk::Endpoint (class)">WscSdk::Endpoint</a></span></tt>)</span>
|
|
369
|
+
|
|
370
|
+
|
|
371
|
+
|
|
372
|
+
—
|
|
373
|
+
<div class='inline'>
|
|
374
|
+
<p>The endpoint that is building the error.</p>
|
|
375
|
+
</div>
|
|
376
|
+
|
|
377
|
+
</li>
|
|
378
|
+
|
|
379
|
+
</ul>
|
|
380
|
+
|
|
381
|
+
<p class="tag_title">Returns:</p>
|
|
382
|
+
<ul class="return">
|
|
383
|
+
|
|
384
|
+
<li>
|
|
385
|
+
|
|
386
|
+
|
|
387
|
+
<span class='type'>(<tt><span class='object_link'><a href="Models/Error.html" title="WscSdk::Models::Error (class)">WscSdk::Models::Error</a></span></tt>)</span>
|
|
388
|
+
|
|
389
|
+
|
|
390
|
+
|
|
391
|
+
—
|
|
392
|
+
<div class='inline'>
|
|
393
|
+
<p>The newly built error object.</p>
|
|
394
|
+
</div>
|
|
395
|
+
|
|
396
|
+
</li>
|
|
397
|
+
|
|
398
|
+
</ul>
|
|
399
|
+
|
|
400
|
+
</div><table class="source_code">
|
|
401
|
+
<tr>
|
|
402
|
+
<td>
|
|
403
|
+
<pre class="lines">
|
|
404
|
+
|
|
405
|
+
|
|
406
|
+
66
|
|
407
|
+
67
|
|
408
|
+
68
|
|
409
|
+
69
|
|
410
|
+
70</pre>
|
|
411
|
+
</td>
|
|
412
|
+
<td>
|
|
413
|
+
<pre class="code"><span class="info file"># File 'lib/wsc_sdk/errors.rb', line 66</span>
|
|
414
|
+
|
|
415
|
+
<span style="color:#080;font-weight:bold">def</span> <span style="color:#069">self</span>.<span style="color:#06B;font-weight:bold">invalid_attributes</span>(endpoint)
|
|
416
|
+
error = <span style="color:#036;font-weight:bold">WscSdk</span>::<span style="color:#036;font-weight:bold">Models</span>::<span style="color:#036;font-weight:bold">Error</span>.new(endpoint)
|
|
417
|
+
error.ingest_attributes(<span style="color:#036;font-weight:bold">INVALID_ATTRIBUTES</span>, <span style="color:#606">write_to_read_only</span>: <span style="color:#069">true</span>, <span style="color:#606">mark_clean</span>: <span style="color:#069">true</span>)
|
|
418
|
+
error
|
|
419
|
+
<span style="color:#080;font-weight:bold">end</span></pre>
|
|
420
|
+
</td>
|
|
421
|
+
</tr>
|
|
422
|
+
</table>
|
|
423
|
+
</div>
|
|
424
|
+
|
|
425
|
+
<div class="method_details ">
|
|
426
|
+
<h3 class="signature " id="invalid_payload-class_method">
|
|
427
|
+
|
|
428
|
+
.<strong>invalid_payload</strong>(endpoint) ⇒ <tt><span class='object_link'><a href="Models/Error.html" title="WscSdk::Models::Error (class)">WscSdk::Models::Error</a></span></tt>
|
|
429
|
+
|
|
430
|
+
|
|
431
|
+
|
|
432
|
+
|
|
433
|
+
|
|
434
|
+
</h3><div class="docstring">
|
|
435
|
+
<div class="discussion">
|
|
436
|
+
|
|
437
|
+
<p>Build an INVALID_PAYLOAD error model object.</p>
|
|
438
|
+
|
|
439
|
+
|
|
440
|
+
</div>
|
|
441
|
+
</div>
|
|
442
|
+
<div class="tags">
|
|
443
|
+
<p class="tag_title">Parameters:</p>
|
|
444
|
+
<ul class="param">
|
|
445
|
+
|
|
446
|
+
<li>
|
|
447
|
+
|
|
448
|
+
<span class='name'>endpoint</span>
|
|
449
|
+
|
|
450
|
+
|
|
451
|
+
<span class='type'>(<tt><span class='object_link'><a href="Endpoint.html" title="WscSdk::Endpoint (class)">WscSdk::Endpoint</a></span></tt>)</span>
|
|
452
|
+
|
|
453
|
+
|
|
454
|
+
|
|
455
|
+
—
|
|
456
|
+
<div class='inline'>
|
|
457
|
+
<p>The endpoint that is building the error.</p>
|
|
458
|
+
</div>
|
|
459
|
+
|
|
460
|
+
</li>
|
|
461
|
+
|
|
462
|
+
</ul>
|
|
463
|
+
|
|
464
|
+
<p class="tag_title">Returns:</p>
|
|
465
|
+
<ul class="return">
|
|
466
|
+
|
|
467
|
+
<li>
|
|
468
|
+
|
|
469
|
+
|
|
470
|
+
<span class='type'>(<tt><span class='object_link'><a href="Models/Error.html" title="WscSdk::Models::Error (class)">WscSdk::Models::Error</a></span></tt>)</span>
|
|
471
|
+
|
|
472
|
+
|
|
473
|
+
|
|
474
|
+
—
|
|
475
|
+
<div class='inline'>
|
|
476
|
+
<p>The newly built error object.</p>
|
|
477
|
+
</div>
|
|
478
|
+
|
|
479
|
+
</li>
|
|
480
|
+
|
|
481
|
+
</ul>
|
|
482
|
+
|
|
483
|
+
</div><table class="source_code">
|
|
484
|
+
<tr>
|
|
485
|
+
<td>
|
|
486
|
+
<pre class="lines">
|
|
487
|
+
|
|
488
|
+
|
|
489
|
+
80
|
|
490
|
+
81
|
|
491
|
+
82
|
|
492
|
+
83
|
|
493
|
+
84</pre>
|
|
494
|
+
</td>
|
|
495
|
+
<td>
|
|
496
|
+
<pre class="code"><span class="info file"># File 'lib/wsc_sdk/errors.rb', line 80</span>
|
|
497
|
+
|
|
498
|
+
<span style="color:#080;font-weight:bold">def</span> <span style="color:#069">self</span>.<span style="color:#06B;font-weight:bold">invalid_payload</span>(endpoint)
|
|
499
|
+
error = <span style="color:#036;font-weight:bold">WscSdk</span>::<span style="color:#036;font-weight:bold">Models</span>::<span style="color:#036;font-weight:bold">Error</span>.new(endpoint)
|
|
500
|
+
error.ingest_attributes(<span style="color:#036;font-weight:bold">INVALID_PAYLOAD</span>, <span style="color:#606">write_to_read_only</span>: <span style="color:#069">true</span>, <span style="color:#606">mark_clean</span>: <span style="color:#069">true</span>)
|
|
501
|
+
error
|
|
502
|
+
<span style="color:#080;font-weight:bold">end</span></pre>
|
|
503
|
+
</td>
|
|
504
|
+
</tr>
|
|
505
|
+
</table>
|
|
506
|
+
</div>
|
|
507
|
+
|
|
508
|
+
<div class="method_details ">
|
|
509
|
+
<h3 class="signature " id="model_does_not_exist-class_method">
|
|
510
|
+
|
|
511
|
+
.<strong>model_does_not_exist</strong>(endpoint) ⇒ <tt><span class='object_link'><a href="Models/Error.html" title="WscSdk::Models::Error (class)">WscSdk::Models::Error</a></span></tt>
|
|
512
|
+
|
|
513
|
+
|
|
514
|
+
|
|
515
|
+
|
|
516
|
+
|
|
517
|
+
</h3><div class="docstring">
|
|
518
|
+
<div class="discussion">
|
|
519
|
+
|
|
520
|
+
<p>Build an RECORD_DOES_NOT_EXIST error model object.</p>
|
|
521
|
+
|
|
522
|
+
|
|
523
|
+
</div>
|
|
524
|
+
</div>
|
|
525
|
+
<div class="tags">
|
|
526
|
+
<p class="tag_title">Parameters:</p>
|
|
527
|
+
<ul class="param">
|
|
528
|
+
|
|
529
|
+
<li>
|
|
530
|
+
|
|
531
|
+
<span class='name'>endpoint</span>
|
|
532
|
+
|
|
533
|
+
|
|
534
|
+
<span class='type'>(<tt><span class='object_link'><a href="Endpoint.html" title="WscSdk::Endpoint (class)">WscSdk::Endpoint</a></span></tt>)</span>
|
|
535
|
+
|
|
536
|
+
|
|
537
|
+
|
|
538
|
+
—
|
|
539
|
+
<div class='inline'>
|
|
540
|
+
<p>The endpoint that is building the error.</p>
|
|
541
|
+
</div>
|
|
542
|
+
|
|
543
|
+
</li>
|
|
544
|
+
|
|
545
|
+
</ul>
|
|
546
|
+
|
|
547
|
+
<p class="tag_title">Returns:</p>
|
|
548
|
+
<ul class="return">
|
|
549
|
+
|
|
550
|
+
<li>
|
|
551
|
+
|
|
552
|
+
|
|
553
|
+
<span class='type'>(<tt><span class='object_link'><a href="Models/Error.html" title="WscSdk::Models::Error (class)">WscSdk::Models::Error</a></span></tt>)</span>
|
|
554
|
+
|
|
555
|
+
|
|
556
|
+
|
|
557
|
+
—
|
|
558
|
+
<div class='inline'>
|
|
559
|
+
<p>The newly built error object.</p>
|
|
560
|
+
</div>
|
|
561
|
+
|
|
562
|
+
</li>
|
|
563
|
+
|
|
564
|
+
</ul>
|
|
565
|
+
|
|
566
|
+
</div><table class="source_code">
|
|
567
|
+
<tr>
|
|
568
|
+
<td>
|
|
569
|
+
<pre class="lines">
|
|
570
|
+
|
|
571
|
+
|
|
572
|
+
94
|
|
573
|
+
95
|
|
574
|
+
96
|
|
575
|
+
97
|
|
576
|
+
98</pre>
|
|
577
|
+
</td>
|
|
578
|
+
<td>
|
|
579
|
+
<pre class="code"><span class="info file"># File 'lib/wsc_sdk/errors.rb', line 94</span>
|
|
580
|
+
|
|
581
|
+
<span style="color:#080;font-weight:bold">def</span> <span style="color:#069">self</span>.<span style="color:#06B;font-weight:bold">model_does_not_exist</span>(endpoint)
|
|
582
|
+
error = <span style="color:#036;font-weight:bold">WscSdk</span>::<span style="color:#036;font-weight:bold">Models</span>::<span style="color:#036;font-weight:bold">Error</span>.new(endpoint)
|
|
583
|
+
error.ingest_attributes(<span style="color:#036;font-weight:bold">MODEL_DOES_NOT_EXIST</span>, <span style="color:#606">write_to_read_only</span>: <span style="color:#069">true</span>, <span style="color:#606">mark_clean</span>: <span style="color:#069">true</span>)
|
|
584
|
+
error
|
|
585
|
+
<span style="color:#080;font-weight:bold">end</span></pre>
|
|
586
|
+
</td>
|
|
587
|
+
</tr>
|
|
588
|
+
</table>
|
|
589
|
+
</div>
|
|
590
|
+
|
|
591
|
+
<div class="method_details ">
|
|
592
|
+
<h3 class="signature " id="model_exists-class_method">
|
|
593
|
+
|
|
594
|
+
.<strong>model_exists</strong>(endpoint) ⇒ <tt><span class='object_link'><a href="Models/Error.html" title="WscSdk::Models::Error (class)">WscSdk::Models::Error</a></span></tt>
|
|
595
|
+
|
|
596
|
+
|
|
597
|
+
|
|
598
|
+
|
|
599
|
+
|
|
600
|
+
</h3><div class="docstring">
|
|
601
|
+
<div class="discussion">
|
|
602
|
+
|
|
603
|
+
<p>Build an RECORD_EXISTS error model object.</p>
|
|
604
|
+
|
|
605
|
+
|
|
606
|
+
</div>
|
|
607
|
+
</div>
|
|
608
|
+
<div class="tags">
|
|
609
|
+
<p class="tag_title">Parameters:</p>
|
|
610
|
+
<ul class="param">
|
|
611
|
+
|
|
612
|
+
<li>
|
|
613
|
+
|
|
614
|
+
<span class='name'>endpoint</span>
|
|
615
|
+
|
|
616
|
+
|
|
617
|
+
<span class='type'>(<tt><span class='object_link'><a href="Endpoint.html" title="WscSdk::Endpoint (class)">WscSdk::Endpoint</a></span></tt>)</span>
|
|
618
|
+
|
|
619
|
+
|
|
620
|
+
|
|
621
|
+
—
|
|
622
|
+
<div class='inline'>
|
|
623
|
+
<p>The endpoint that is building the error.</p>
|
|
624
|
+
</div>
|
|
625
|
+
|
|
626
|
+
</li>
|
|
627
|
+
|
|
628
|
+
</ul>
|
|
629
|
+
|
|
630
|
+
<p class="tag_title">Returns:</p>
|
|
631
|
+
<ul class="return">
|
|
632
|
+
|
|
633
|
+
<li>
|
|
634
|
+
|
|
635
|
+
|
|
636
|
+
<span class='type'>(<tt><span class='object_link'><a href="Models/Error.html" title="WscSdk::Models::Error (class)">WscSdk::Models::Error</a></span></tt>)</span>
|
|
637
|
+
|
|
638
|
+
|
|
639
|
+
|
|
640
|
+
—
|
|
641
|
+
<div class='inline'>
|
|
642
|
+
<p>The newly built error object.</p>
|
|
643
|
+
</div>
|
|
644
|
+
|
|
645
|
+
</li>
|
|
646
|
+
|
|
647
|
+
</ul>
|
|
648
|
+
|
|
649
|
+
</div><table class="source_code">
|
|
650
|
+
<tr>
|
|
651
|
+
<td>
|
|
652
|
+
<pre class="lines">
|
|
653
|
+
|
|
654
|
+
|
|
655
|
+
108
|
|
656
|
+
109
|
|
657
|
+
110
|
|
658
|
+
111
|
|
659
|
+
112</pre>
|
|
660
|
+
</td>
|
|
661
|
+
<td>
|
|
662
|
+
<pre class="code"><span class="info file"># File 'lib/wsc_sdk/errors.rb', line 108</span>
|
|
663
|
+
|
|
664
|
+
<span style="color:#080;font-weight:bold">def</span> <span style="color:#069">self</span>.<span style="color:#06B;font-weight:bold">model_exists</span>(endpoint)
|
|
665
|
+
error = <span style="color:#036;font-weight:bold">WscSdk</span>::<span style="color:#036;font-weight:bold">Models</span>::<span style="color:#036;font-weight:bold">Error</span>.new(endpoint)
|
|
666
|
+
error.ingest_attributes(<span style="color:#036;font-weight:bold">MODEL_EXISTS</span>, <span style="color:#606">write_to_read_only</span>: <span style="color:#069">true</span>, <span style="color:#606">mark_clean</span>: <span style="color:#069">true</span>)
|
|
667
|
+
error
|
|
668
|
+
<span style="color:#080;font-weight:bold">end</span></pre>
|
|
669
|
+
</td>
|
|
670
|
+
</tr>
|
|
671
|
+
</table>
|
|
672
|
+
</div>
|
|
673
|
+
|
|
674
|
+
</div>
|
|
675
|
+
|
|
676
|
+
</div>
|
|
677
|
+
|
|
678
|
+
|
|
679
|
+
</div>
|
|
680
|
+
</div>
|
|
681
|
+
</div>
|
|
682
|
+
</body>
|
|
683
|
+
</html>
|