blob: 775cb63813055756ac1c93ea53721c853ca05f92 [file] [log] [blame]
yoshi-code-bot466c9a92021-11-22 23:24:31 -08001<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="datastream_v1.html">Datastream API</a> . <a href="datastream_v1.projects.html">projects</a> . <a href="datastream_v1.projects.locations.html">locations</a> . <a href="datastream_v1.projects.locations.streams.html">streams</a> . <a href="datastream_v1.projects.locations.streams.objects.html">objects</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
80<p class="toc_element">
81 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
82<p class="firstline">Use this method to get details about a stream object.</p>
83<p class="toc_element">
84 <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
85<p class="firstline">Use this method to list the objects of a specific stream.</p>
86<p class="toc_element">
87 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
88<p class="firstline">Retrieves the next page of results.</p>
89<p class="toc_element">
90 <code><a href="#lookup">lookup(parent, body=None, x__xgafv=None)</a></code></p>
91<p class="firstline">Use this method to look up a stream object by its source object identifier.</p>
92<p class="toc_element">
93 <code><a href="#startBackfillJob">startBackfillJob(object, body=None, x__xgafv=None)</a></code></p>
94<p class="firstline">Starts backfill job for the specified stream object.</p>
95<p class="toc_element">
96 <code><a href="#stopBackfillJob">stopBackfillJob(object, body=None, x__xgafv=None)</a></code></p>
97<p class="firstline">Stops the backfill job for the specified stream object.</p>
98<h3>Method Details</h3>
99<div class="method">
100 <code class="details" id="close">close()</code>
101 <pre>Close httplib2 connections.</pre>
102</div>
103
104<div class="method">
105 <code class="details" id="get">get(name, x__xgafv=None)</code>
106 <pre>Use this method to get details about a stream object.
107
108Args:
109 name: string, Required. The name of the stream object resource to get. (required)
110 x__xgafv: string, V1 error format.
111 Allowed values
112 1 - v1 error format
113 2 - v2 error format
114
115Returns:
116 An object of the form:
117
118 { # A specific stream object (e.g a specific DB table).
119 &quot;backfillJob&quot;: { # Represents a backfill job on a specific stream object. # The latest backfill job that was initiated for the stream object.
120 &quot;errors&quot;: [ # Output only. Errors which caused the backfill job to fail.
121 { # Represent a user-facing Error.
122 &quot;details&quot;: { # Additional information about the error.
123 &quot;a_key&quot;: &quot;A String&quot;,
124 },
125 &quot;errorTime&quot;: &quot;A String&quot;, # The time when the error occurred.
126 &quot;errorUuid&quot;: &quot;A String&quot;, # A unique identifier for this specific error, allowing it to be traced throughout the system in logs and API responses.
127 &quot;message&quot;: &quot;A String&quot;, # A message containing more information about the error that occurred.
128 &quot;reason&quot;: &quot;A String&quot;, # A title that explains the reason for the error.
129 },
130 ],
131 &quot;lastEndTime&quot;: &quot;A String&quot;, # Output only. Backfill job&#x27;s end time.
132 &quot;lastStartTime&quot;: &quot;A String&quot;, # Output only. Backfill job&#x27;s start time.
133 &quot;state&quot;: &quot;A String&quot;, # Backfill job state.
134 &quot;trigger&quot;: &quot;A String&quot;, # Backfill job&#x27;s triggering reason.
135 },
136 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The creation time of the object.
137 &quot;displayName&quot;: &quot;A String&quot;, # Required. Display name.
138 &quot;errors&quot;: [ # Output only. Active errors on the object.
139 { # Represent a user-facing Error.
140 &quot;details&quot;: { # Additional information about the error.
141 &quot;a_key&quot;: &quot;A String&quot;,
142 },
143 &quot;errorTime&quot;: &quot;A String&quot;, # The time when the error occurred.
144 &quot;errorUuid&quot;: &quot;A String&quot;, # A unique identifier for this specific error, allowing it to be traced throughout the system in logs and API responses.
145 &quot;message&quot;: &quot;A String&quot;, # A message containing more information about the error that occurred.
146 &quot;reason&quot;: &quot;A String&quot;, # A title that explains the reason for the error.
147 },
148 ],
149 &quot;name&quot;: &quot;A String&quot;, # Output only. The object resource&#x27;s name.
150 &quot;sourceObject&quot;: { # Represents an identifier of an object in the data source. # The object identifier in the data source.
151 &quot;mysqlIdentifier&quot;: { # Mysql data source object identifier. # Mysql data source object identifier.
152 &quot;database&quot;: &quot;A String&quot;, # The database name.
153 &quot;table&quot;: &quot;A String&quot;, # The table name.
154 },
155 &quot;oracleIdentifier&quot;: { # Oracle data source object identifier. # Oracle data source object identifier.
156 &quot;schema&quot;: &quot;A String&quot;, # The schema name.
157 &quot;table&quot;: &quot;A String&quot;, # The table name.
158 },
159 },
160 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The last update time of the object.
161}</pre>
162</div>
163
164<div class="method">
165 <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
166 <pre>Use this method to list the objects of a specific stream.
167
168Args:
169 parent: string, Required. The parent stream that owns the collection of objects. (required)
170 pageSize: integer, Maximum number of objects to return. Default is 50. The maximum value is 1000; values above 1000 will be coerced to 1000.
171 pageToken: string, Page token received from a previous `ListStreamObjectsRequest` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListStreamObjectsRequest` must match the call that provided the page token.
172 x__xgafv: string, V1 error format.
173 Allowed values
174 1 - v1 error format
175 2 - v2 error format
176
177Returns:
178 An object of the form:
179
180 { # Response containing the objects for a stream.
181 &quot;nextPageToken&quot;: &quot;A String&quot;, # A token, which can be sent as `page_token` to retrieve the next page.
182 &quot;streamObjects&quot;: [ # List of stream objects.
183 { # A specific stream object (e.g a specific DB table).
184 &quot;backfillJob&quot;: { # Represents a backfill job on a specific stream object. # The latest backfill job that was initiated for the stream object.
185 &quot;errors&quot;: [ # Output only. Errors which caused the backfill job to fail.
186 { # Represent a user-facing Error.
187 &quot;details&quot;: { # Additional information about the error.
188 &quot;a_key&quot;: &quot;A String&quot;,
189 },
190 &quot;errorTime&quot;: &quot;A String&quot;, # The time when the error occurred.
191 &quot;errorUuid&quot;: &quot;A String&quot;, # A unique identifier for this specific error, allowing it to be traced throughout the system in logs and API responses.
192 &quot;message&quot;: &quot;A String&quot;, # A message containing more information about the error that occurred.
193 &quot;reason&quot;: &quot;A String&quot;, # A title that explains the reason for the error.
194 },
195 ],
196 &quot;lastEndTime&quot;: &quot;A String&quot;, # Output only. Backfill job&#x27;s end time.
197 &quot;lastStartTime&quot;: &quot;A String&quot;, # Output only. Backfill job&#x27;s start time.
198 &quot;state&quot;: &quot;A String&quot;, # Backfill job state.
199 &quot;trigger&quot;: &quot;A String&quot;, # Backfill job&#x27;s triggering reason.
200 },
201 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The creation time of the object.
202 &quot;displayName&quot;: &quot;A String&quot;, # Required. Display name.
203 &quot;errors&quot;: [ # Output only. Active errors on the object.
204 { # Represent a user-facing Error.
205 &quot;details&quot;: { # Additional information about the error.
206 &quot;a_key&quot;: &quot;A String&quot;,
207 },
208 &quot;errorTime&quot;: &quot;A String&quot;, # The time when the error occurred.
209 &quot;errorUuid&quot;: &quot;A String&quot;, # A unique identifier for this specific error, allowing it to be traced throughout the system in logs and API responses.
210 &quot;message&quot;: &quot;A String&quot;, # A message containing more information about the error that occurred.
211 &quot;reason&quot;: &quot;A String&quot;, # A title that explains the reason for the error.
212 },
213 ],
214 &quot;name&quot;: &quot;A String&quot;, # Output only. The object resource&#x27;s name.
215 &quot;sourceObject&quot;: { # Represents an identifier of an object in the data source. # The object identifier in the data source.
216 &quot;mysqlIdentifier&quot;: { # Mysql data source object identifier. # Mysql data source object identifier.
217 &quot;database&quot;: &quot;A String&quot;, # The database name.
218 &quot;table&quot;: &quot;A String&quot;, # The table name.
219 },
220 &quot;oracleIdentifier&quot;: { # Oracle data source object identifier. # Oracle data source object identifier.
221 &quot;schema&quot;: &quot;A String&quot;, # The schema name.
222 &quot;table&quot;: &quot;A String&quot;, # The table name.
223 },
224 },
225 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The last update time of the object.
226 },
227 ],
228}</pre>
229</div>
230
231<div class="method">
232 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
233 <pre>Retrieves the next page of results.
234
235Args:
236 previous_request: The request for the previous page. (required)
237 previous_response: The response from the request for the previous page. (required)
238
239Returns:
240 A request object that you can call &#x27;execute()&#x27; on to request the next
241 page. Returns None if there are no more items in the collection.
242 </pre>
243</div>
244
245<div class="method">
246 <code class="details" id="lookup">lookup(parent, body=None, x__xgafv=None)</code>
247 <pre>Use this method to look up a stream object by its source object identifier.
248
249Args:
250 parent: string, Required. The parent stream that owns the collection of objects. (required)
251 body: object, The request body.
252 The object takes the form of:
253
254{ # Request for looking up a specific stream object by its source object identifier.
255 &quot;sourceObjectIdentifier&quot;: { # Represents an identifier of an object in the data source. # Required. The source object identifier which maps to the stream object.
256 &quot;mysqlIdentifier&quot;: { # Mysql data source object identifier. # Mysql data source object identifier.
257 &quot;database&quot;: &quot;A String&quot;, # The database name.
258 &quot;table&quot;: &quot;A String&quot;, # The table name.
259 },
260 &quot;oracleIdentifier&quot;: { # Oracle data source object identifier. # Oracle data source object identifier.
261 &quot;schema&quot;: &quot;A String&quot;, # The schema name.
262 &quot;table&quot;: &quot;A String&quot;, # The table name.
263 },
264 },
265}
266
267 x__xgafv: string, V1 error format.
268 Allowed values
269 1 - v1 error format
270 2 - v2 error format
271
272Returns:
273 An object of the form:
274
275 { # A specific stream object (e.g a specific DB table).
276 &quot;backfillJob&quot;: { # Represents a backfill job on a specific stream object. # The latest backfill job that was initiated for the stream object.
277 &quot;errors&quot;: [ # Output only. Errors which caused the backfill job to fail.
278 { # Represent a user-facing Error.
279 &quot;details&quot;: { # Additional information about the error.
280 &quot;a_key&quot;: &quot;A String&quot;,
281 },
282 &quot;errorTime&quot;: &quot;A String&quot;, # The time when the error occurred.
283 &quot;errorUuid&quot;: &quot;A String&quot;, # A unique identifier for this specific error, allowing it to be traced throughout the system in logs and API responses.
284 &quot;message&quot;: &quot;A String&quot;, # A message containing more information about the error that occurred.
285 &quot;reason&quot;: &quot;A String&quot;, # A title that explains the reason for the error.
286 },
287 ],
288 &quot;lastEndTime&quot;: &quot;A String&quot;, # Output only. Backfill job&#x27;s end time.
289 &quot;lastStartTime&quot;: &quot;A String&quot;, # Output only. Backfill job&#x27;s start time.
290 &quot;state&quot;: &quot;A String&quot;, # Backfill job state.
291 &quot;trigger&quot;: &quot;A String&quot;, # Backfill job&#x27;s triggering reason.
292 },
293 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The creation time of the object.
294 &quot;displayName&quot;: &quot;A String&quot;, # Required. Display name.
295 &quot;errors&quot;: [ # Output only. Active errors on the object.
296 { # Represent a user-facing Error.
297 &quot;details&quot;: { # Additional information about the error.
298 &quot;a_key&quot;: &quot;A String&quot;,
299 },
300 &quot;errorTime&quot;: &quot;A String&quot;, # The time when the error occurred.
301 &quot;errorUuid&quot;: &quot;A String&quot;, # A unique identifier for this specific error, allowing it to be traced throughout the system in logs and API responses.
302 &quot;message&quot;: &quot;A String&quot;, # A message containing more information about the error that occurred.
303 &quot;reason&quot;: &quot;A String&quot;, # A title that explains the reason for the error.
304 },
305 ],
306 &quot;name&quot;: &quot;A String&quot;, # Output only. The object resource&#x27;s name.
307 &quot;sourceObject&quot;: { # Represents an identifier of an object in the data source. # The object identifier in the data source.
308 &quot;mysqlIdentifier&quot;: { # Mysql data source object identifier. # Mysql data source object identifier.
309 &quot;database&quot;: &quot;A String&quot;, # The database name.
310 &quot;table&quot;: &quot;A String&quot;, # The table name.
311 },
312 &quot;oracleIdentifier&quot;: { # Oracle data source object identifier. # Oracle data source object identifier.
313 &quot;schema&quot;: &quot;A String&quot;, # The schema name.
314 &quot;table&quot;: &quot;A String&quot;, # The table name.
315 },
316 },
317 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The last update time of the object.
318}</pre>
319</div>
320
321<div class="method">
322 <code class="details" id="startBackfillJob">startBackfillJob(object, body=None, x__xgafv=None)</code>
323 <pre>Starts backfill job for the specified stream object.
324
325Args:
326 object: string, Required. The name of the stream object resource to start a backfill job for. (required)
327 body: object, The request body.
328 The object takes the form of:
329
330{ # Request for manually initiating a backfill job for a specific stream object.
331}
332
333 x__xgafv: string, V1 error format.
334 Allowed values
335 1 - v1 error format
336 2 - v2 error format
337
338Returns:
339 An object of the form:
340
341 { # Response for manually initiating a backfill job for a specific stream object.
342 &quot;object&quot;: { # A specific stream object (e.g a specific DB table). # The stream object resource a backfill job was started for.
343 &quot;backfillJob&quot;: { # Represents a backfill job on a specific stream object. # The latest backfill job that was initiated for the stream object.
344 &quot;errors&quot;: [ # Output only. Errors which caused the backfill job to fail.
345 { # Represent a user-facing Error.
346 &quot;details&quot;: { # Additional information about the error.
347 &quot;a_key&quot;: &quot;A String&quot;,
348 },
349 &quot;errorTime&quot;: &quot;A String&quot;, # The time when the error occurred.
350 &quot;errorUuid&quot;: &quot;A String&quot;, # A unique identifier for this specific error, allowing it to be traced throughout the system in logs and API responses.
351 &quot;message&quot;: &quot;A String&quot;, # A message containing more information about the error that occurred.
352 &quot;reason&quot;: &quot;A String&quot;, # A title that explains the reason for the error.
353 },
354 ],
355 &quot;lastEndTime&quot;: &quot;A String&quot;, # Output only. Backfill job&#x27;s end time.
356 &quot;lastStartTime&quot;: &quot;A String&quot;, # Output only. Backfill job&#x27;s start time.
357 &quot;state&quot;: &quot;A String&quot;, # Backfill job state.
358 &quot;trigger&quot;: &quot;A String&quot;, # Backfill job&#x27;s triggering reason.
359 },
360 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The creation time of the object.
361 &quot;displayName&quot;: &quot;A String&quot;, # Required. Display name.
362 &quot;errors&quot;: [ # Output only. Active errors on the object.
363 { # Represent a user-facing Error.
364 &quot;details&quot;: { # Additional information about the error.
365 &quot;a_key&quot;: &quot;A String&quot;,
366 },
367 &quot;errorTime&quot;: &quot;A String&quot;, # The time when the error occurred.
368 &quot;errorUuid&quot;: &quot;A String&quot;, # A unique identifier for this specific error, allowing it to be traced throughout the system in logs and API responses.
369 &quot;message&quot;: &quot;A String&quot;, # A message containing more information about the error that occurred.
370 &quot;reason&quot;: &quot;A String&quot;, # A title that explains the reason for the error.
371 },
372 ],
373 &quot;name&quot;: &quot;A String&quot;, # Output only. The object resource&#x27;s name.
374 &quot;sourceObject&quot;: { # Represents an identifier of an object in the data source. # The object identifier in the data source.
375 &quot;mysqlIdentifier&quot;: { # Mysql data source object identifier. # Mysql data source object identifier.
376 &quot;database&quot;: &quot;A String&quot;, # The database name.
377 &quot;table&quot;: &quot;A String&quot;, # The table name.
378 },
379 &quot;oracleIdentifier&quot;: { # Oracle data source object identifier. # Oracle data source object identifier.
380 &quot;schema&quot;: &quot;A String&quot;, # The schema name.
381 &quot;table&quot;: &quot;A String&quot;, # The table name.
382 },
383 },
384 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The last update time of the object.
385 },
386}</pre>
387</div>
388
389<div class="method">
390 <code class="details" id="stopBackfillJob">stopBackfillJob(object, body=None, x__xgafv=None)</code>
391 <pre>Stops the backfill job for the specified stream object.
392
393Args:
394 object: string, Required. The name of the stream object resource to stop the backfill job for. (required)
395 body: object, The request body.
396 The object takes the form of:
397
398{ # Request for manually stopping a running backfill job for a specific stream object.
399}
400
401 x__xgafv: string, V1 error format.
402 Allowed values
403 1 - v1 error format
404 2 - v2 error format
405
406Returns:
407 An object of the form:
408
409 { # Response for manually stop a backfill job for a specific stream object.
410 &quot;object&quot;: { # A specific stream object (e.g a specific DB table). # The stream object resource the backfill job was stopped for.
411 &quot;backfillJob&quot;: { # Represents a backfill job on a specific stream object. # The latest backfill job that was initiated for the stream object.
412 &quot;errors&quot;: [ # Output only. Errors which caused the backfill job to fail.
413 { # Represent a user-facing Error.
414 &quot;details&quot;: { # Additional information about the error.
415 &quot;a_key&quot;: &quot;A String&quot;,
416 },
417 &quot;errorTime&quot;: &quot;A String&quot;, # The time when the error occurred.
418 &quot;errorUuid&quot;: &quot;A String&quot;, # A unique identifier for this specific error, allowing it to be traced throughout the system in logs and API responses.
419 &quot;message&quot;: &quot;A String&quot;, # A message containing more information about the error that occurred.
420 &quot;reason&quot;: &quot;A String&quot;, # A title that explains the reason for the error.
421 },
422 ],
423 &quot;lastEndTime&quot;: &quot;A String&quot;, # Output only. Backfill job&#x27;s end time.
424 &quot;lastStartTime&quot;: &quot;A String&quot;, # Output only. Backfill job&#x27;s start time.
425 &quot;state&quot;: &quot;A String&quot;, # Backfill job state.
426 &quot;trigger&quot;: &quot;A String&quot;, # Backfill job&#x27;s triggering reason.
427 },
428 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The creation time of the object.
429 &quot;displayName&quot;: &quot;A String&quot;, # Required. Display name.
430 &quot;errors&quot;: [ # Output only. Active errors on the object.
431 { # Represent a user-facing Error.
432 &quot;details&quot;: { # Additional information about the error.
433 &quot;a_key&quot;: &quot;A String&quot;,
434 },
435 &quot;errorTime&quot;: &quot;A String&quot;, # The time when the error occurred.
436 &quot;errorUuid&quot;: &quot;A String&quot;, # A unique identifier for this specific error, allowing it to be traced throughout the system in logs and API responses.
437 &quot;message&quot;: &quot;A String&quot;, # A message containing more information about the error that occurred.
438 &quot;reason&quot;: &quot;A String&quot;, # A title that explains the reason for the error.
439 },
440 ],
441 &quot;name&quot;: &quot;A String&quot;, # Output only. The object resource&#x27;s name.
442 &quot;sourceObject&quot;: { # Represents an identifier of an object in the data source. # The object identifier in the data source.
443 &quot;mysqlIdentifier&quot;: { # Mysql data source object identifier. # Mysql data source object identifier.
444 &quot;database&quot;: &quot;A String&quot;, # The database name.
445 &quot;table&quot;: &quot;A String&quot;, # The table name.
446 },
447 &quot;oracleIdentifier&quot;: { # Oracle data source object identifier. # Oracle data source object identifier.
448 &quot;schema&quot;: &quot;A String&quot;, # The schema name.
449 &quot;table&quot;: &quot;A String&quot;, # The table name.
450 },
451 },
452 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The last update time of the object.
453 },
454}</pre>
455</div>
456
457</body></html>