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
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<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>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Use this method to get details about a stream object.</p>
<p class="toc_element">
<code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Use this method to list the objects of a specific stream.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#lookup">lookup(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Use this method to look up a stream object by its source object identifier.</p>
<p class="toc_element">
<code><a href="#startBackfillJob">startBackfillJob(object, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Use this method to start a backfill job for the specified stream object.</p>
<p class="toc_element">
<code><a href="#stopBackfillJob">stopBackfillJob(object, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Use this method to stop a backfill job for the specified stream object.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
<pre>Use this method to get details about a stream object.
Args:
name: string, Required. The name of the stream object resource to get. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A specific stream object (e.g a specific DB table).
"backfillJob": { # Represents a backfill job on a specific stream object. # The latest backfill job that was initiated for the stream object.
"errors": [ # Output only. Errors which caused the backfill job to fail.
{ # Represent a user-facing Error.
"details": { # Additional information about the error.
"a_key": "A String",
},
"errorTime": "A String", # The time when the error occurred.
"errorUuid": "A String", # A unique identifier for this specific error, allowing it to be traced throughout the system in logs and API responses.
"message": "A String", # A message containing more information about the error that occurred.
"reason": "A String", # A title that explains the reason for the error.
},
],
"lastEndTime": "A String", # Output only. Backfill job's end time.
"lastStartTime": "A String", # Output only. Backfill job's start time.
"state": "A String", # Output only. Backfill job state.
"trigger": "A String", # Backfill job's triggering reason.
},
"createTime": "A String", # Output only. The creation time of the object.
"displayName": "A String", # Required. Display name.
"errors": [ # Output only. Active errors on the object.
{ # Represent a user-facing Error.
"details": { # Additional information about the error.
"a_key": "A String",
},
"errorTime": "A String", # The time when the error occurred.
"errorUuid": "A String", # A unique identifier for this specific error, allowing it to be traced throughout the system in logs and API responses.
"message": "A String", # A message containing more information about the error that occurred.
"reason": "A String", # A title that explains the reason for the error.
},
],
"name": "A String", # Output only. Identifier. The object resource's name.
"sourceObject": { # Represents an identifier of an object in the data source. # The object identifier in the data source.
"mongodbIdentifier": { # MongoDB data source object identifier. # MongoDB data source object identifier.
"collection": "A String", # Required. The collection name.
"database": "A String", # Required. The database name.
},
"mysqlIdentifier": { # Mysql data source object identifier. # Mysql data source object identifier.
"database": "A String", # Required. The database name.
"table": "A String", # Required. The table name.
},
"oracleIdentifier": { # Oracle data source object identifier. # Oracle data source object identifier.
"schema": "A String", # Required. The schema name.
"table": "A String", # Required. The table name.
},
"postgresqlIdentifier": { # PostgreSQL data source object identifier. # PostgreSQL data source object identifier.
"schema": "A String", # Required. The schema name.
"table": "A String", # Required. The table name.
},
"salesforceIdentifier": { # Salesforce data source object identifier. # Salesforce data source object identifier.
"objectName": "A String", # Required. The object name.
},
"sqlServerIdentifier": { # SQLServer data source object identifier. # SQLServer data source object identifier.
"schema": "A String", # Required. The schema name.
"table": "A String", # Required. The table name.
},
},
"updateTime": "A String", # Output only. The last update time of the object.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Use this method to list the objects of a specific stream.
Args:
parent: string, Required. The parent stream that owns the collection of objects. (required)
pageSize: integer, Maximum number of objects to return. Default is 50. The maximum value is 1000; values above 1000 will be coerced to 1000.
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.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response containing the objects for a stream.
"nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page.
"streamObjects": [ # List of stream objects.
{ # A specific stream object (e.g a specific DB table).
"backfillJob": { # Represents a backfill job on a specific stream object. # The latest backfill job that was initiated for the stream object.
"errors": [ # Output only. Errors which caused the backfill job to fail.
{ # Represent a user-facing Error.
"details": { # Additional information about the error.
"a_key": "A String",
},
"errorTime": "A String", # The time when the error occurred.
"errorUuid": "A String", # A unique identifier for this specific error, allowing it to be traced throughout the system in logs and API responses.
"message": "A String", # A message containing more information about the error that occurred.
"reason": "A String", # A title that explains the reason for the error.
},
],
"lastEndTime": "A String", # Output only. Backfill job's end time.
"lastStartTime": "A String", # Output only. Backfill job's start time.
"state": "A String", # Output only. Backfill job state.
"trigger": "A String", # Backfill job's triggering reason.
},
"createTime": "A String", # Output only. The creation time of the object.
"displayName": "A String", # Required. Display name.
"errors": [ # Output only. Active errors on the object.
{ # Represent a user-facing Error.
"details": { # Additional information about the error.
"a_key": "A String",
},
"errorTime": "A String", # The time when the error occurred.
"errorUuid": "A String", # A unique identifier for this specific error, allowing it to be traced throughout the system in logs and API responses.
"message": "A String", # A message containing more information about the error that occurred.
"reason": "A String", # A title that explains the reason for the error.
},
],
"name": "A String", # Output only. Identifier. The object resource's name.
"sourceObject": { # Represents an identifier of an object in the data source. # The object identifier in the data source.
"mongodbIdentifier": { # MongoDB data source object identifier. # MongoDB data source object identifier.
"collection": "A String", # Required. The collection name.
"database": "A String", # Required. The database name.
},
"mysqlIdentifier": { # Mysql data source object identifier. # Mysql data source object identifier.
"database": "A String", # Required. The database name.
"table": "A String", # Required. The table name.
},
"oracleIdentifier": { # Oracle data source object identifier. # Oracle data source object identifier.
"schema": "A String", # Required. The schema name.
"table": "A String", # Required. The table name.
},
"postgresqlIdentifier": { # PostgreSQL data source object identifier. # PostgreSQL data source object identifier.
"schema": "A String", # Required. The schema name.
"table": "A String", # Required. The table name.
},
"salesforceIdentifier": { # Salesforce data source object identifier. # Salesforce data source object identifier.
"objectName": "A String", # Required. The object name.
},
"sqlServerIdentifier": { # SQLServer data source object identifier. # SQLServer data source object identifier.
"schema": "A String", # Required. The schema name.
"table": "A String", # Required. The table name.
},
},
"updateTime": "A String", # Output only. The last update time of the object.
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
<div class="method">
<code class="details" id="lookup">lookup(parent, body=None, x__xgafv=None)</code>
<pre>Use this method to look up a stream object by its source object identifier.
Args:
parent: string, Required. The parent stream that owns the collection of objects. (required)
body: object, The request body.
The object takes the form of:
{ # Request for looking up a specific stream object by its source object identifier.
"sourceObjectIdentifier": { # Represents an identifier of an object in the data source. # Required. The source object identifier which maps to the stream object.
"mongodbIdentifier": { # MongoDB data source object identifier. # MongoDB data source object identifier.
"collection": "A String", # Required. The collection name.
"database": "A String", # Required. The database name.
},
"mysqlIdentifier": { # Mysql data source object identifier. # Mysql data source object identifier.
"database": "A String", # Required. The database name.
"table": "A String", # Required. The table name.
},
"oracleIdentifier": { # Oracle data source object identifier. # Oracle data source object identifier.
"schema": "A String", # Required. The schema name.
"table": "A String", # Required. The table name.
},
"postgresqlIdentifier": { # PostgreSQL data source object identifier. # PostgreSQL data source object identifier.
"schema": "A String", # Required. The schema name.
"table": "A String", # Required. The table name.
},
"salesforceIdentifier": { # Salesforce data source object identifier. # Salesforce data source object identifier.
"objectName": "A String", # Required. The object name.
},
"sqlServerIdentifier": { # SQLServer data source object identifier. # SQLServer data source object identifier.
"schema": "A String", # Required. The schema name.
"table": "A String", # Required. The table name.
},
},
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A specific stream object (e.g a specific DB table).
"backfillJob": { # Represents a backfill job on a specific stream object. # The latest backfill job that was initiated for the stream object.
"errors": [ # Output only. Errors which caused the backfill job to fail.
{ # Represent a user-facing Error.
"details": { # Additional information about the error.
"a_key": "A String",
},
"errorTime": "A String", # The time when the error occurred.
"errorUuid": "A String", # A unique identifier for this specific error, allowing it to be traced throughout the system in logs and API responses.
"message": "A String", # A message containing more information about the error that occurred.
"reason": "A String", # A title that explains the reason for the error.
},
],
"lastEndTime": "A String", # Output only. Backfill job's end time.
"lastStartTime": "A String", # Output only. Backfill job's start time.
"state": "A String", # Output only. Backfill job state.
"trigger": "A String", # Backfill job's triggering reason.
},
"createTime": "A String", # Output only. The creation time of the object.
"displayName": "A String", # Required. Display name.
"errors": [ # Output only. Active errors on the object.
{ # Represent a user-facing Error.
"details": { # Additional information about the error.
"a_key": "A String",
},
"errorTime": "A String", # The time when the error occurred.
"errorUuid": "A String", # A unique identifier for this specific error, allowing it to be traced throughout the system in logs and API responses.
"message": "A String", # A message containing more information about the error that occurred.
"reason": "A String", # A title that explains the reason for the error.
},
],
"name": "A String", # Output only. Identifier. The object resource's name.
"sourceObject": { # Represents an identifier of an object in the data source. # The object identifier in the data source.
"mongodbIdentifier": { # MongoDB data source object identifier. # MongoDB data source object identifier.
"collection": "A String", # Required. The collection name.
"database": "A String", # Required. The database name.
},
"mysqlIdentifier": { # Mysql data source object identifier. # Mysql data source object identifier.
"database": "A String", # Required. The database name.
"table": "A String", # Required. The table name.
},
"oracleIdentifier": { # Oracle data source object identifier. # Oracle data source object identifier.
"schema": "A String", # Required. The schema name.
"table": "A String", # Required. The table name.
},
"postgresqlIdentifier": { # PostgreSQL data source object identifier. # PostgreSQL data source object identifier.
"schema": "A String", # Required. The schema name.
"table": "A String", # Required. The table name.
},
"salesforceIdentifier": { # Salesforce data source object identifier. # Salesforce data source object identifier.
"objectName": "A String", # Required. The object name.
},
"sqlServerIdentifier": { # SQLServer data source object identifier. # SQLServer data source object identifier.
"schema": "A String", # Required. The schema name.
"table": "A String", # Required. The table name.
},
},
"updateTime": "A String", # Output only. The last update time of the object.
}</pre>
</div>
<div class="method">
<code class="details" id="startBackfillJob">startBackfillJob(object, body=None, x__xgafv=None)</code>
<pre>Use this method to start a backfill job for the specified stream object.
Args:
object: string, Required. The name of the stream object resource to start a backfill job for. (required)
body: object, The request body.
The object takes the form of:
{ # Request for manually initiating a backfill job for a specific stream object.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response for manually initiating a backfill job for a specific stream object.
"object": { # A specific stream object (e.g a specific DB table). # The stream object resource a backfill job was started for.
"backfillJob": { # Represents a backfill job on a specific stream object. # The latest backfill job that was initiated for the stream object.
"errors": [ # Output only. Errors which caused the backfill job to fail.
{ # Represent a user-facing Error.
"details": { # Additional information about the error.
"a_key": "A String",
},
"errorTime": "A String", # The time when the error occurred.
"errorUuid": "A String", # A unique identifier for this specific error, allowing it to be traced throughout the system in logs and API responses.
"message": "A String", # A message containing more information about the error that occurred.
"reason": "A String", # A title that explains the reason for the error.
},
],
"lastEndTime": "A String", # Output only. Backfill job's end time.
"lastStartTime": "A String", # Output only. Backfill job's start time.
"state": "A String", # Output only. Backfill job state.
"trigger": "A String", # Backfill job's triggering reason.
},
"createTime": "A String", # Output only. The creation time of the object.
"displayName": "A String", # Required. Display name.
"errors": [ # Output only. Active errors on the object.
{ # Represent a user-facing Error.
"details": { # Additional information about the error.
"a_key": "A String",
},
"errorTime": "A String", # The time when the error occurred.
"errorUuid": "A String", # A unique identifier for this specific error, allowing it to be traced throughout the system in logs and API responses.
"message": "A String", # A message containing more information about the error that occurred.
"reason": "A String", # A title that explains the reason for the error.
},
],
"name": "A String", # Output only. Identifier. The object resource's name.
"sourceObject": { # Represents an identifier of an object in the data source. # The object identifier in the data source.
"mongodbIdentifier": { # MongoDB data source object identifier. # MongoDB data source object identifier.
"collection": "A String", # Required. The collection name.
"database": "A String", # Required. The database name.
},
"mysqlIdentifier": { # Mysql data source object identifier. # Mysql data source object identifier.
"database": "A String", # Required. The database name.
"table": "A String", # Required. The table name.
},
"oracleIdentifier": { # Oracle data source object identifier. # Oracle data source object identifier.
"schema": "A String", # Required. The schema name.
"table": "A String", # Required. The table name.
},
"postgresqlIdentifier": { # PostgreSQL data source object identifier. # PostgreSQL data source object identifier.
"schema": "A String", # Required. The schema name.
"table": "A String", # Required. The table name.
},
"salesforceIdentifier": { # Salesforce data source object identifier. # Salesforce data source object identifier.
"objectName": "A String", # Required. The object name.
},
"sqlServerIdentifier": { # SQLServer data source object identifier. # SQLServer data source object identifier.
"schema": "A String", # Required. The schema name.
"table": "A String", # Required. The table name.
},
},
"updateTime": "A String", # Output only. The last update time of the object.
},
}</pre>
</div>
<div class="method">
<code class="details" id="stopBackfillJob">stopBackfillJob(object, body=None, x__xgafv=None)</code>
<pre>Use this method to stop a backfill job for the specified stream object.
Args:
object: string, Required. The name of the stream object resource to stop the backfill job for. (required)
body: object, The request body.
The object takes the form of:
{ # Request for manually stopping a running backfill job for a specific stream object.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response for manually stop a backfill job for a specific stream object.
"object": { # A specific stream object (e.g a specific DB table). # The stream object resource the backfill job was stopped for.
"backfillJob": { # Represents a backfill job on a specific stream object. # The latest backfill job that was initiated for the stream object.
"errors": [ # Output only. Errors which caused the backfill job to fail.
{ # Represent a user-facing Error.
"details": { # Additional information about the error.
"a_key": "A String",
},
"errorTime": "A String", # The time when the error occurred.
"errorUuid": "A String", # A unique identifier for this specific error, allowing it to be traced throughout the system in logs and API responses.
"message": "A String", # A message containing more information about the error that occurred.
"reason": "A String", # A title that explains the reason for the error.
},
],
"lastEndTime": "A String", # Output only. Backfill job's end time.
"lastStartTime": "A String", # Output only. Backfill job's start time.
"state": "A String", # Output only. Backfill job state.
"trigger": "A String", # Backfill job's triggering reason.
},
"createTime": "A String", # Output only. The creation time of the object.
"displayName": "A String", # Required. Display name.
"errors": [ # Output only. Active errors on the object.
{ # Represent a user-facing Error.
"details": { # Additional information about the error.
"a_key": "A String",
},
"errorTime": "A String", # The time when the error occurred.
"errorUuid": "A String", # A unique identifier for this specific error, allowing it to be traced throughout the system in logs and API responses.
"message": "A String", # A message containing more information about the error that occurred.
"reason": "A String", # A title that explains the reason for the error.
},
],
"name": "A String", # Output only. Identifier. The object resource's name.
"sourceObject": { # Represents an identifier of an object in the data source. # The object identifier in the data source.
"mongodbIdentifier": { # MongoDB data source object identifier. # MongoDB data source object identifier.
"collection": "A String", # Required. The collection name.
"database": "A String", # Required. The database name.
},
"mysqlIdentifier": { # Mysql data source object identifier. # Mysql data source object identifier.
"database": "A String", # Required. The database name.
"table": "A String", # Required. The table name.
},
"oracleIdentifier": { # Oracle data source object identifier. # Oracle data source object identifier.
"schema": "A String", # Required. The schema name.
"table": "A String", # Required. The table name.
},
"postgresqlIdentifier": { # PostgreSQL data source object identifier. # PostgreSQL data source object identifier.
"schema": "A String", # Required. The schema name.
"table": "A String", # Required. The table name.
},
"salesforceIdentifier": { # Salesforce data source object identifier. # Salesforce data source object identifier.
"objectName": "A String", # Required. The object name.
},
"sqlServerIdentifier": { # SQLServer data source object identifier. # SQLServer data source object identifier.
"schema": "A String", # Required. The schema name.
"table": "A String", # Required. The table name.
},
},
"updateTime": "A String", # Output only. The last update time of the object.
},
}</pre>
</div>
</body></html>
|
