Repository navigation
Expand file tree
/
Copy pathevents_streams.html
More file actions
274 lines (206 loc) · 12.2 KB
/
Copy pathevents_streams.html
File metadata and controls
274 lines (206 loc) · 12.2 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
<!DOCTYPE html>
<html lang="en">
<head>
<link rel="stylesheet" type="text/css" href="https://fonts.googleapis.com/css?family=Overpass:300,400,600,800">
<script src="https://code.jquery.com/jquery-3.4.1.min.js" integrity="sha256-CSXorXvZcTkaix6Yvo6HppcZGetbYMGWSFlBw8HfCJo=" crossorigin="anonymous"></script>
<link href="https://stackpath.bootstrapcdn.com/bootstrap/4.3.1/css/bootstrap.min.css" rel="stylesheet" integrity="sha384-ggOyR0iXCbMQv3Xipma34MD+dH/1fQ784/j6cY/iJTQUOhcWr7x9JvoRxT2MZw1T" crossorigin="anonymous">
<script src="https://stackpath.bootstrapcdn.com/bootstrap/4.3.1/js/bootstrap.min.js" integrity="sha384-JjSmVgyd0p3pXB1rRibZUAYoIIy6OrQ6VrjIEaFf/nJGzIxFDsf4x0xIM+B07jRM" crossorigin="anonymous"></script>
<link rel="stylesheet" type="text/css" href="schema_doc.css">
<script src="https://use.fontawesome.com/facf9fa52c.js"></script>
<script src="schema_doc.min.js"></script>
<meta charset="utf-8"/>
<title>Streams Events</title>
<script src="schema_extras.js" ></script></head>
<body onload="anchorOnLoad();removedHostedMDExtensions();" id="root"><nav> <ol class="breadcrumb bg-white" style="padding: 0"> <li class="breadcrumb-item"><a href="../../">UDMI</a></li> <li class="breadcrumb-item"><a href="../">Schema</a></li> <li class="breadcrumb-item"><a href="./">Schema Viewer</a></li> </ol> </nav> <div class="text-right">
<button class="btn btn-primary" type="button" data-toggle="collapse" data-target=".collapse:not(.show)" aria-expanded="false">Expand all</button>
<button class="btn btn-primary" type="button" data-toggle="collapse" data-target=".collapse.show" aria-expanded="false">Collapse all</button>
</div>
<div class="breadcrumbs"></div> <h1>Streams Events</h1><span class="badge badge-dark value-type">Type: object</span><br/>
<span class="description"><p>Sequential data stream chunks for reliable transport over MQTT (e.g. PCAP traces, firmware blobs, reliable alarms, logs playback).</p>
</span> <span class="badge badge-info no-additional">No Additional Properties</span>
<div class="accordion" id="accordiontimestamp">
<div class="card">
<div class="card-header" id="headingtimestamp">
<h2 class="mb-0">
<button class="btn btn-link property-name-button" type="button" data-toggle="collapse" data-target="#timestamp"
aria-expanded="" aria-controls="timestamp" onclick="setAnchor('#timestamp')"><span class="property-name">timestamp</span></button>
</h2>
</div>
<div id="timestamp"
class="collapse property-definition-div" aria-labelledby="headingtimestamp"
data-parent="#accordiontimestamp">
<div class="card-body pl-5">
<div class="breadcrumbs">root
<svg width="1em" height="1em" viewBox="0 0 16 16" class="bi bi-arrow-right-short" fill="currentColor" xmlns="http://www.w3.org/2000/svg">
<path
fill-rule="evenodd"
d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z"
/>
</svg>
<a href="#timestamp" onclick="anchorLink('timestamp')">timestamp</a></div><span class="badge badge-dark value-type">Type: string</span><span class="badge badge-info value-type">Format: date-time</span><br/>
<span class="description"><p>RFC 3339 UTC timestamp the stream chunk event was generated</p>
</span>
</div>
</div>
</div>
</div>
<div class="accordion" id="accordionversion">
<div class="card">
<div class="card-header" id="headingversion">
<h2 class="mb-0">
<button class="btn btn-link property-name-button" type="button" data-toggle="collapse" data-target="#version"
aria-expanded="" aria-controls="version" onclick="setAnchor('#version')"><span class="property-name">version</span></button>
</h2>
</div>
<div id="version"
class="collapse property-definition-div" aria-labelledby="headingversion"
data-parent="#accordionversion">
<div class="card-body pl-5">
<div class="breadcrumbs">root
<svg width="1em" height="1em" viewBox="0 0 16 16" class="bi bi-arrow-right-short" fill="currentColor" xmlns="http://www.w3.org/2000/svg">
<path
fill-rule="evenodd"
d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z"
/>
</svg>
<a href="#version" onclick="anchorLink('version')">version</a></div><span class="badge badge-dark value-type">Type: string</span><br/>
<span class="description"><p>Version of the UDMI schema</p>
</span>
</div>
</div>
</div>
</div>
<div class="accordion" id="accordionsession_id">
<div class="card">
<div class="card-header" id="headingsession_id">
<h2 class="mb-0">
<button class="btn btn-link property-name-button" type="button" data-toggle="collapse" data-target="#session_id"
aria-expanded="" aria-controls="session_id" onclick="setAnchor('#session_id')"><span class="property-name">session_id</span></button>
</h2>
</div>
<div id="session_id"
class="collapse property-definition-div" aria-labelledby="headingsession_id"
data-parent="#accordionsession_id">
<div class="card-body pl-5">
<div class="breadcrumbs">root
<svg width="1em" height="1em" viewBox="0 0 16 16" class="bi bi-arrow-right-short" fill="currentColor" xmlns="http://www.w3.org/2000/svg">
<path
fill-rule="evenodd"
d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z"
/>
</svg>
<a href="#session_id" onclick="anchorLink('session_id')">session_id</a></div><span class="badge badge-dark value-type">Type: string</span><br/>
<span class="description"><p>Unique session identifier for the continuous stream transmission</p>
</span>
</div>
</div>
</div>
</div>
<div class="accordion" id="accordionevent_no">
<div class="card">
<div class="card-header" id="headingevent_no">
<h2 class="mb-0">
<button class="btn btn-link property-name-button" type="button" data-toggle="collapse" data-target="#event_no"
aria-expanded="" aria-controls="event_no" onclick="setAnchor('#event_no')"><span class="property-name">event_no</span></button>
</h2>
</div>
<div id="event_no"
class="collapse property-definition-div" aria-labelledby="headingevent_no"
data-parent="#accordionevent_no">
<div class="card-body pl-5">
<div class="breadcrumbs">root
<svg width="1em" height="1em" viewBox="0 0 16 16" class="bi bi-arrow-right-short" fill="currentColor" xmlns="http://www.w3.org/2000/svg">
<path
fill-rule="evenodd"
d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z"
/>
</svg>
<a href="#event_no" onclick="anchorLink('event_no')">event_no</a></div><span class="badge badge-dark value-type">Type: integer</span><br/>
<span class="description"><p>Sequence number for this stream event to support reliable sequential delivery and reassembly</p>
</span>
</div>
</div>
</div>
</div>
<div class="accordion" id="accordionchunk_index">
<div class="card">
<div class="card-header" id="headingchunk_index">
<h2 class="mb-0">
<button class="btn btn-link property-name-button" type="button" data-toggle="collapse" data-target="#chunk_index"
aria-expanded="" aria-controls="chunk_index" onclick="setAnchor('#chunk_index')"><span class="property-name">chunk_index</span></button>
</h2>
</div>
<div id="chunk_index"
class="collapse property-definition-div" aria-labelledby="headingchunk_index"
data-parent="#accordionchunk_index">
<div class="card-body pl-5">
<div class="breadcrumbs">root
<svg width="1em" height="1em" viewBox="0 0 16 16" class="bi bi-arrow-right-short" fill="currentColor" xmlns="http://www.w3.org/2000/svg">
<path
fill-rule="evenodd"
d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z"
/>
</svg>
<a href="#chunk_index" onclick="anchorLink('chunk_index')">chunk_index</a></div><span class="badge badge-dark value-type">Type: integer</span><br/>
<span class="description"><p>0-based index of the transmitted chunk payload within the total session</p>
</span>
</div>
</div>
</div>
</div>
<div class="accordion" id="accordiontotal_chunks">
<div class="card">
<div class="card-header" id="headingtotal_chunks">
<h2 class="mb-0">
<button class="btn btn-link property-name-button" type="button" data-toggle="collapse" data-target="#total_chunks"
aria-expanded="" aria-controls="total_chunks" onclick="setAnchor('#total_chunks')"><span class="property-name">total_chunks</span></button>
</h2>
</div>
<div id="total_chunks"
class="collapse property-definition-div" aria-labelledby="headingtotal_chunks"
data-parent="#accordiontotal_chunks">
<div class="card-body pl-5">
<div class="breadcrumbs">root
<svg width="1em" height="1em" viewBox="0 0 16 16" class="bi bi-arrow-right-short" fill="currentColor" xmlns="http://www.w3.org/2000/svg">
<path
fill-rule="evenodd"
d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z"
/>
</svg>
<a href="#total_chunks" onclick="anchorLink('total_chunks')">total_chunks</a></div><span class="badge badge-dark value-type">Type: integer</span><br/>
<span class="description"><p>Total number of chunks comprising the complete transmission binary</p>
</span>
</div>
</div>
</div>
</div>
<div class="accordion" id="accordiondata">
<div class="card">
<div class="card-header" id="headingdata">
<h2 class="mb-0">
<button class="btn btn-link property-name-button" type="button" data-toggle="collapse" data-target="#data"
aria-expanded="" aria-controls="data" onclick="setAnchor('#data')"><span class="property-name">data</span></button>
</h2>
</div>
<div id="data"
class="collapse property-definition-div" aria-labelledby="headingdata"
data-parent="#accordiondata">
<div class="card-body pl-5">
<div class="breadcrumbs">root
<svg width="1em" height="1em" viewBox="0 0 16 16" class="bi bi-arrow-right-short" fill="currentColor" xmlns="http://www.w3.org/2000/svg">
<path
fill-rule="evenodd"
d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z"
/>
</svg>
<a href="#data" onclick="anchorLink('data')">data</a></div><span class="badge badge-dark value-type">Type: string</span><br/>
<span class="description"><p>Base64-encoded binary chunk payload data</p>
</span>
</div>
</div>
</div>
</div>
<footer>
<p class="generated-by-footer">Generated using <a href="https://github.com/coveooss/json-schema-for-humans">json-schema-for-humans</a></p>
</footer></body>
</html>