Debian Codegraph @

docs/dyn/datastream_v1.projects.locations.streams.objects.html

raw
1 <html><body>
2 <style>
3
4 body, 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
15 body {
16 font-size: 13px;
17 padding: 1em;
18 }
19
20 h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23 }
24
25 h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28 }
29
30 h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34 }
35
36 pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39 }
40
41 pre {
42 margin-top: 0.5em;
43 }
44
45 h1, h2, h3, p {
46 font-family: Arial, sans serif;
47 }
48
49 h1, 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()</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">Use this method to start a 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">Use this method to stop a 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
108 Args:
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
115 Returns:
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;eventFilter&quot;: { # Represents a filter for included data on a stream object. # Output only. The filter for performing a partial backfill.
132 &quot;sqlWhereClause&quot;: &quot;A String&quot;, # An SQL-query Where clause selecting which data should be included, not including the &quot;WHERE&quot; keyword. e.g., `t.key1 = &#x27;value1&#x27; AND t.key2 = &#x27;value2&#x27;`
133 },
134 &quot;lastEndTime&quot;: &quot;A String&quot;, # Output only. Backfill job&#x27;s end time.
135 &quot;lastStartTime&quot;: &quot;A String&quot;, # Output only. Backfill job&#x27;s start time.
136 &quot;state&quot;: &quot;A String&quot;, # Output only. Backfill job state.
137 &quot;trigger&quot;: &quot;A String&quot;, # Backfill job&#x27;s triggering reason.
138 },
139 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The creation time of the object.
140 &quot;customizationRules&quot;: [ # Output only. The customization rules for the object. These rules are derived from the parent Stream&#x27;s `rule_sets` and represent the intended configuration for the object.
141 { # A customization rule to apply to a set of objects.
142 &quot;bigqueryClustering&quot;: { # BigQuery clustering configuration. # BigQuery clustering rule.
143 &quot;columns&quot;: [ # Required. Column names to set as clustering columns.
144 &quot;A String&quot;,
145 ],
146 },
147 &quot;bigqueryPartitioning&quot;: { # BigQuery partitioning configuration. # BigQuery partitioning rule.
148 &quot;ingestionTimePartition&quot;: { # Ingestion time partitioning. see https://cloud.google.com/bigquery/docs/partitioned-tables#ingestion_time # Ingestion time partitioning.
149 &quot;partitioningTimeGranularity&quot;: &quot;A String&quot;, # Optional. Partition granularity
150 },
151 &quot;integerRangePartition&quot;: { # Integer range partitioning. see https://cloud.google.com/bigquery/docs/partitioned-tables#integer_range # Integer range partitioning.
152 &quot;column&quot;: &quot;A String&quot;, # Required. The partitioning column.
153 &quot;end&quot;: &quot;A String&quot;, # Required. The ending value for range partitioning (exclusive).
154 &quot;interval&quot;: &quot;A String&quot;, # Required. The interval of each range within the partition.
155 &quot;start&quot;: &quot;A String&quot;, # Required. The starting value for range partitioning (inclusive).
156 },
157 &quot;requirePartitionFilter&quot;: True or False, # Optional. If true, queries over the table require a partition filter.
158 &quot;timeUnitPartition&quot;: { # Time unit column partitioning. see https://cloud.google.com/bigquery/docs/partitioned-tables#date_timestamp_partitioned_tables # Time unit column partitioning.
159 &quot;column&quot;: &quot;A String&quot;, # Required. The partitioning column.
160 &quot;partitioningTimeGranularity&quot;: &quot;A String&quot;, # Optional. Partition granularity.
161 },
162 },
163 },
164 ],
165 &quot;displayName&quot;: &quot;A String&quot;, # Required. Display name.
166 &quot;errors&quot;: [ # Output only. Active errors on the object.
167 { # Represent a user-facing Error.
168 &quot;details&quot;: { # Additional information about the error.
169 &quot;a_key&quot;: &quot;A String&quot;,
170 },
171 &quot;errorTime&quot;: &quot;A String&quot;, # The time when the error occurred.
172 &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.
173 &quot;message&quot;: &quot;A String&quot;, # A message containing more information about the error that occurred.
174 &quot;reason&quot;: &quot;A String&quot;, # A title that explains the reason for the error.
175 },
176 ],
177 &quot;name&quot;: &quot;A String&quot;, # Output only. Identifier. The object resource&#x27;s name.
178 &quot;sourceObject&quot;: { # Represents an identifier of an object in the data source. # The object identifier in the data source.
179 &quot;mongodbIdentifier&quot;: { # MongoDB data source object identifier. # MongoDB data source object identifier.
180 &quot;collection&quot;: &quot;A String&quot;, # Required. The collection name.
181 &quot;database&quot;: &quot;A String&quot;, # Required. The database name.
182 },
183 &quot;mysqlIdentifier&quot;: { # Mysql data source object identifier. # Mysql data source object identifier.
184 &quot;database&quot;: &quot;A String&quot;, # Required. The database name.
185 &quot;table&quot;: &quot;A String&quot;, # Required. The table name.
186 },
187 &quot;oracleIdentifier&quot;: { # Oracle data source object identifier. # Oracle data source object identifier.
188 &quot;schema&quot;: &quot;A String&quot;, # Required. The schema name.
189 &quot;table&quot;: &quot;A String&quot;, # Required. The table name.
190 },
191 &quot;postgresqlIdentifier&quot;: { # PostgreSQL data source object identifier. # PostgreSQL data source object identifier.
192 &quot;schema&quot;: &quot;A String&quot;, # Required. The schema name.
193 &quot;table&quot;: &quot;A String&quot;, # Required. The table name.
194 },
195 &quot;salesforceIdentifier&quot;: { # Salesforce data source object identifier. # Salesforce data source object identifier.
196 &quot;objectName&quot;: &quot;A String&quot;, # Required. The object name.
197 },
198 &quot;spannerIdentifier&quot;: { # Spanner data source object identifier. # Spanner data source object identifier.
199 &quot;schema&quot;: &quot;A String&quot;, # Optional. The schema name.
200 &quot;table&quot;: &quot;A String&quot;, # Required. The table name.
201 },
202 &quot;sqlServerIdentifier&quot;: { # SQLServer data source object identifier. # SQLServer data source object identifier.
203 &quot;schema&quot;: &quot;A String&quot;, # Required. The schema name.
204 &quot;table&quot;: &quot;A String&quot;, # Required. The table name.
205 },
206 },
207 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The last update time of the object.
208 }</pre>
209 </div>
210
211 <div class="method">
212 <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
213 <pre>Use this method to list the objects of a specific stream.
214
215 Args:
216 parent: string, Required. The parent stream that owns the collection of objects. (required)
217 pageSize: integer, Optional. Maximum number of objects to return. Default is 50. The maximum value is 1000; values above 1000 will be coerced to 1000.
218 pageToken: string, Optional. 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.
219 x__xgafv: string, V1 error format.
220 Allowed values
221 1 - v1 error format
222 2 - v2 error format
223
224 Returns:
225 An object of the form:
226
227 { # Response containing the objects for a stream.
228 &quot;nextPageToken&quot;: &quot;A String&quot;, # A token, which can be sent as `page_token` to retrieve the next page.
229 &quot;streamObjects&quot;: [ # List of stream objects.
230 { # A specific stream object (e.g a specific DB table).
231 &quot;backfillJob&quot;: { # Represents a backfill job on a specific stream object. # The latest backfill job that was initiated for the stream object.
232 &quot;errors&quot;: [ # Output only. Errors which caused the backfill job to fail.
233 { # Represent a user-facing Error.
234 &quot;details&quot;: { # Additional information about the error.
235 &quot;a_key&quot;: &quot;A String&quot;,
236 },
237 &quot;errorTime&quot;: &quot;A String&quot;, # The time when the error occurred.
238 &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.
239 &quot;message&quot;: &quot;A String&quot;, # A message containing more information about the error that occurred.
240 &quot;reason&quot;: &quot;A String&quot;, # A title that explains the reason for the error.
241 },
242 ],
243 &quot;eventFilter&quot;: { # Represents a filter for included data on a stream object. # Output only. The filter for performing a partial backfill.
244 &quot;sqlWhereClause&quot;: &quot;A String&quot;, # An SQL-query Where clause selecting which data should be included, not including the &quot;WHERE&quot; keyword. e.g., `t.key1 = &#x27;value1&#x27; AND t.key2 = &#x27;value2&#x27;`
245 },
246 &quot;lastEndTime&quot;: &quot;A String&quot;, # Output only. Backfill job&#x27;s end time.
247 &quot;lastStartTime&quot;: &quot;A String&quot;, # Output only. Backfill job&#x27;s start time.
248 &quot;state&quot;: &quot;A String&quot;, # Output only. Backfill job state.
249 &quot;trigger&quot;: &quot;A String&quot;, # Backfill job&#x27;s triggering reason.
250 },
251 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The creation time of the object.
252 &quot;customizationRules&quot;: [ # Output only. The customization rules for the object. These rules are derived from the parent Stream&#x27;s `rule_sets` and represent the intended configuration for the object.
253 { # A customization rule to apply to a set of objects.
254 &quot;bigqueryClustering&quot;: { # BigQuery clustering configuration. # BigQuery clustering rule.
255 &quot;columns&quot;: [ # Required. Column names to set as clustering columns.
256 &quot;A String&quot;,
257 ],
258 },
259 &quot;bigqueryPartitioning&quot;: { # BigQuery partitioning configuration. # BigQuery partitioning rule.
260 &quot;ingestionTimePartition&quot;: { # Ingestion time partitioning. see https://cloud.google.com/bigquery/docs/partitioned-tables#ingestion_time # Ingestion time partitioning.
261 &quot;partitioningTimeGranularity&quot;: &quot;A String&quot;, # Optional. Partition granularity
262 },
263 &quot;integerRangePartition&quot;: { # Integer range partitioning. see https://cloud.google.com/bigquery/docs/partitioned-tables#integer_range # Integer range partitioning.
264 &quot;column&quot;: &quot;A String&quot;, # Required. The partitioning column.
265 &quot;end&quot;: &quot;A String&quot;, # Required. The ending value for range partitioning (exclusive).
266 &quot;interval&quot;: &quot;A String&quot;, # Required. The interval of each range within the partition.
267 &quot;start&quot;: &quot;A String&quot;, # Required. The starting value for range partitioning (inclusive).
268 },
269 &quot;requirePartitionFilter&quot;: True or False, # Optional. If true, queries over the table require a partition filter.
270 &quot;timeUnitPartition&quot;: { # Time unit column partitioning. see https://cloud.google.com/bigquery/docs/partitioned-tables#date_timestamp_partitioned_tables # Time unit column partitioning.
271 &quot;column&quot;: &quot;A String&quot;, # Required. The partitioning column.
272 &quot;partitioningTimeGranularity&quot;: &quot;A String&quot;, # Optional. Partition granularity.
273 },
274 },
275 },
276 ],
277 &quot;displayName&quot;: &quot;A String&quot;, # Required. Display name.
278 &quot;errors&quot;: [ # Output only. Active errors on the object.
279 { # Represent a user-facing Error.
280 &quot;details&quot;: { # Additional information about the error.
281 &quot;a_key&quot;: &quot;A String&quot;,
282 },
283 &quot;errorTime&quot;: &quot;A String&quot;, # The time when the error occurred.
284 &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.
285 &quot;message&quot;: &quot;A String&quot;, # A message containing more information about the error that occurred.
286 &quot;reason&quot;: &quot;A String&quot;, # A title that explains the reason for the error.
287 },
288 ],
289 &quot;name&quot;: &quot;A String&quot;, # Output only. Identifier. The object resource&#x27;s name.
290 &quot;sourceObject&quot;: { # Represents an identifier of an object in the data source. # The object identifier in the data source.
291 &quot;mongodbIdentifier&quot;: { # MongoDB data source object identifier. # MongoDB data source object identifier.
292 &quot;collection&quot;: &quot;A String&quot;, # Required. The collection name.
293 &quot;database&quot;: &quot;A String&quot;, # Required. The database name.
294 },
295 &quot;mysqlIdentifier&quot;: { # Mysql data source object identifier. # Mysql data source object identifier.
296 &quot;database&quot;: &quot;A String&quot;, # Required. The database name.
297 &quot;table&quot;: &quot;A String&quot;, # Required. The table name.
298 },
299 &quot;oracleIdentifier&quot;: { # Oracle data source object identifier. # Oracle data source object identifier.
300 &quot;schema&quot;: &quot;A String&quot;, # Required. The schema name.
301 &quot;table&quot;: &quot;A String&quot;, # Required. The table name.
302 },
303 &quot;postgresqlIdentifier&quot;: { # PostgreSQL data source object identifier. # PostgreSQL data source object identifier.
304 &quot;schema&quot;: &quot;A String&quot;, # Required. The schema name.
305 &quot;table&quot;: &quot;A String&quot;, # Required. The table name.
306 },
307 &quot;salesforceIdentifier&quot;: { # Salesforce data source object identifier. # Salesforce data source object identifier.
308 &quot;objectName&quot;: &quot;A String&quot;, # Required. The object name.
309 },
310 &quot;spannerIdentifier&quot;: { # Spanner data source object identifier. # Spanner data source object identifier.
311 &quot;schema&quot;: &quot;A String&quot;, # Optional. The schema name.
312 &quot;table&quot;: &quot;A String&quot;, # Required. The table name.
313 },
314 &quot;sqlServerIdentifier&quot;: { # SQLServer data source object identifier. # SQLServer data source object identifier.
315 &quot;schema&quot;: &quot;A String&quot;, # Required. The schema name.
316 &quot;table&quot;: &quot;A String&quot;, # Required. The table name.
317 },
318 },
319 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The last update time of the object.
320 },
321 ],
322 }</pre>
323 </div>
324
325 <div class="method">
326 <code class="details" id="list_next">list_next()</code>
327 <pre>Retrieves the next page of results.
328
329 Args:
330 previous_request: The request for the previous page. (required)
331 previous_response: The response from the request for the previous page. (required)
332
333 Returns:
334 A request object that you can call &#x27;execute()&#x27; on to request the next
335 page. Returns None if there are no more items in the collection.
336 </pre>
337 </div>
338
339 <div class="method">
340 <code class="details" id="lookup">lookup(parent, body=None, x__xgafv=None)</code>
341 <pre>Use this method to look up a stream object by its source object identifier.
342
343 Args:
344 parent: string, Required. The parent stream that owns the collection of objects. (required)
345 body: object, The request body.
346 The object takes the form of:
347
348 { # Request for looking up a specific stream object by its source object identifier.
349 &quot;sourceObjectIdentifier&quot;: { # Represents an identifier of an object in the data source. # Required. The source object identifier which maps to the stream object.
350 &quot;mongodbIdentifier&quot;: { # MongoDB data source object identifier. # MongoDB data source object identifier.
351 &quot;collection&quot;: &quot;A String&quot;, # Required. The collection name.
352 &quot;database&quot;: &quot;A String&quot;, # Required. The database name.
353 },
354 &quot;mysqlIdentifier&quot;: { # Mysql data source object identifier. # Mysql data source object identifier.
355 &quot;database&quot;: &quot;A String&quot;, # Required. The database name.
356 &quot;table&quot;: &quot;A String&quot;, # Required. The table name.
357 },
358 &quot;oracleIdentifier&quot;: { # Oracle data source object identifier. # Oracle data source object identifier.
359 &quot;schema&quot;: &quot;A String&quot;, # Required. The schema name.
360 &quot;table&quot;: &quot;A String&quot;, # Required. The table name.
361 },
362 &quot;postgresqlIdentifier&quot;: { # PostgreSQL data source object identifier. # PostgreSQL data source object identifier.
363 &quot;schema&quot;: &quot;A String&quot;, # Required. The schema name.
364 &quot;table&quot;: &quot;A String&quot;, # Required. The table name.
365 },
366 &quot;salesforceIdentifier&quot;: { # Salesforce data source object identifier. # Salesforce data source object identifier.
367 &quot;objectName&quot;: &quot;A String&quot;, # Required. The object name.
368 },
369 &quot;spannerIdentifier&quot;: { # Spanner data source object identifier. # Spanner data source object identifier.
370 &quot;schema&quot;: &quot;A String&quot;, # Optional. The schema name.
371 &quot;table&quot;: &quot;A String&quot;, # Required. The table name.
372 },
373 &quot;sqlServerIdentifier&quot;: { # SQLServer data source object identifier. # SQLServer data source object identifier.
374 &quot;schema&quot;: &quot;A String&quot;, # Required. The schema name.
375 &quot;table&quot;: &quot;A String&quot;, # Required. The table name.
376 },
377 },
378 }
379
380 x__xgafv: string, V1 error format.
381 Allowed values
382 1 - v1 error format
383 2 - v2 error format
384
385 Returns:
386 An object of the form:
387
388 { # A specific stream object (e.g a specific DB table).
389 &quot;backfillJob&quot;: { # Represents a backfill job on a specific stream object. # The latest backfill job that was initiated for the stream object.
390 &quot;errors&quot;: [ # Output only. Errors which caused the backfill job to fail.
391 { # Represent a user-facing Error.
392 &quot;details&quot;: { # Additional information about the error.
393 &quot;a_key&quot;: &quot;A String&quot;,
394 },
395 &quot;errorTime&quot;: &quot;A String&quot;, # The time when the error occurred.
396 &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.
397 &quot;message&quot;: &quot;A String&quot;, # A message containing more information about the error that occurred.
398 &quot;reason&quot;: &quot;A String&quot;, # A title that explains the reason for the error.
399 },
400 ],
401 &quot;eventFilter&quot;: { # Represents a filter for included data on a stream object. # Output only. The filter for performing a partial backfill.
402 &quot;sqlWhereClause&quot;: &quot;A String&quot;, # An SQL-query Where clause selecting which data should be included, not including the &quot;WHERE&quot; keyword. e.g., `t.key1 = &#x27;value1&#x27; AND t.key2 = &#x27;value2&#x27;`
403 },
404 &quot;lastEndTime&quot;: &quot;A String&quot;, # Output only. Backfill job&#x27;s end time.
405 &quot;lastStartTime&quot;: &quot;A String&quot;, # Output only. Backfill job&#x27;s start time.
406 &quot;state&quot;: &quot;A String&quot;, # Output only. Backfill job state.
407 &quot;trigger&quot;: &quot;A String&quot;, # Backfill job&#x27;s triggering reason.
408 },
409 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The creation time of the object.
410 &quot;customizationRules&quot;: [ # Output only. The customization rules for the object. These rules are derived from the parent Stream&#x27;s `rule_sets` and represent the intended configuration for the object.
411 { # A customization rule to apply to a set of objects.
412 &quot;bigqueryClustering&quot;: { # BigQuery clustering configuration. # BigQuery clustering rule.
413 &quot;columns&quot;: [ # Required. Column names to set as clustering columns.
414 &quot;A String&quot;,
415 ],
416 },
417 &quot;bigqueryPartitioning&quot;: { # BigQuery partitioning configuration. # BigQuery partitioning rule.
418 &quot;ingestionTimePartition&quot;: { # Ingestion time partitioning. see https://cloud.google.com/bigquery/docs/partitioned-tables#ingestion_time # Ingestion time partitioning.
419 &quot;partitioningTimeGranularity&quot;: &quot;A String&quot;, # Optional. Partition granularity
420 },
421 &quot;integerRangePartition&quot;: { # Integer range partitioning. see https://cloud.google.com/bigquery/docs/partitioned-tables#integer_range # Integer range partitioning.
422 &quot;column&quot;: &quot;A String&quot;, # Required. The partitioning column.
423 &quot;end&quot;: &quot;A String&quot;, # Required. The ending value for range partitioning (exclusive).
424 &quot;interval&quot;: &quot;A String&quot;, # Required. The interval of each range within the partition.
425 &quot;start&quot;: &quot;A String&quot;, # Required. The starting value for range partitioning (inclusive).
426 },
427 &quot;requirePartitionFilter&quot;: True or False, # Optional. If true, queries over the table require a partition filter.
428 &quot;timeUnitPartition&quot;: { # Time unit column partitioning. see https://cloud.google.com/bigquery/docs/partitioned-tables#date_timestamp_partitioned_tables # Time unit column partitioning.
429 &quot;column&quot;: &quot;A String&quot;, # Required. The partitioning column.
430 &quot;partitioningTimeGranularity&quot;: &quot;A String&quot;, # Optional. Partition granularity.
431 },
432 },
433 },
434 ],
435 &quot;displayName&quot;: &quot;A String&quot;, # Required. Display name.
436 &quot;errors&quot;: [ # Output only. Active errors on the object.
437 { # Represent a user-facing Error.
438 &quot;details&quot;: { # Additional information about the error.
439 &quot;a_key&quot;: &quot;A String&quot;,
440 },
441 &quot;errorTime&quot;: &quot;A String&quot;, # The time when the error occurred.
442 &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.
443 &quot;message&quot;: &quot;A String&quot;, # A message containing more information about the error that occurred.
444 &quot;reason&quot;: &quot;A String&quot;, # A title that explains the reason for the error.
445 },
446 ],
447 &quot;name&quot;: &quot;A String&quot;, # Output only. Identifier. The object resource&#x27;s name.
448 &quot;sourceObject&quot;: { # Represents an identifier of an object in the data source. # The object identifier in the data source.
449 &quot;mongodbIdentifier&quot;: { # MongoDB data source object identifier. # MongoDB data source object identifier.
450 &quot;collection&quot;: &quot;A String&quot;, # Required. The collection name.
451 &quot;database&quot;: &quot;A String&quot;, # Required. The database name.
452 },
453 &quot;mysqlIdentifier&quot;: { # Mysql data source object identifier. # Mysql data source object identifier.
454 &quot;database&quot;: &quot;A String&quot;, # Required. The database name.
455 &quot;table&quot;: &quot;A String&quot;, # Required. The table name.
456 },
457 &quot;oracleIdentifier&quot;: { # Oracle data source object identifier. # Oracle data source object identifier.
458 &quot;schema&quot;: &quot;A String&quot;, # Required. The schema name.
459 &quot;table&quot;: &quot;A String&quot;, # Required. The table name.
460 },
461 &quot;postgresqlIdentifier&quot;: { # PostgreSQL data source object identifier. # PostgreSQL data source object identifier.
462 &quot;schema&quot;: &quot;A String&quot;, # Required. The schema name.
463 &quot;table&quot;: &quot;A String&quot;, # Required. The table name.
464 },
465 &quot;salesforceIdentifier&quot;: { # Salesforce data source object identifier. # Salesforce data source object identifier.
466 &quot;objectName&quot;: &quot;A String&quot;, # Required. The object name.
467 },
468 &quot;spannerIdentifier&quot;: { # Spanner data source object identifier. # Spanner data source object identifier.
469 &quot;schema&quot;: &quot;A String&quot;, # Optional. The schema name.
470 &quot;table&quot;: &quot;A String&quot;, # Required. The table name.
471 },
472 &quot;sqlServerIdentifier&quot;: { # SQLServer data source object identifier. # SQLServer data source object identifier.
473 &quot;schema&quot;: &quot;A String&quot;, # Required. The schema name.
474 &quot;table&quot;: &quot;A String&quot;, # Required. The table name.
475 },
476 },
477 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The last update time of the object.
478 }</pre>
479 </div>
480
481 <div class="method">
482 <code class="details" id="startBackfillJob">startBackfillJob(object, body=None, x__xgafv=None)</code>
483 <pre>Use this method to start a backfill job for the specified stream object.
484
485 Args:
486 object: string, Required. The name of the stream object resource to start a backfill job for. (required)
487 body: object, The request body.
488 The object takes the form of:
489
490 { # Request for manually initiating a backfill job for a specific stream object.
491 &quot;eventFilter&quot;: { # Represents a filter for included data on a stream object. # Optional. Optional event filter. If not set, or empty, the backfill will be performed on the entire object. This is currently used for partial backfill and only supported for SQL sources.
492 &quot;sqlWhereClause&quot;: &quot;A String&quot;, # An SQL-query Where clause selecting which data should be included, not including the &quot;WHERE&quot; keyword. e.g., `t.key1 = &#x27;value1&#x27; AND t.key2 = &#x27;value2&#x27;`
493 },
494 }
495
496 x__xgafv: string, V1 error format.
497 Allowed values
498 1 - v1 error format
499 2 - v2 error format
500
501 Returns:
502 An object of the form:
503
504 { # Response for manually initiating a backfill job for a specific stream object.
505 &quot;object&quot;: { # A specific stream object (e.g a specific DB table). # The stream object resource a backfill job was started for.
506 &quot;backfillJob&quot;: { # Represents a backfill job on a specific stream object. # The latest backfill job that was initiated for the stream object.
507 &quot;errors&quot;: [ # Output only. Errors which caused the backfill job to fail.
508 { # Represent a user-facing Error.
509 &quot;details&quot;: { # Additional information about the error.
510 &quot;a_key&quot;: &quot;A String&quot;,
511 },
512 &quot;errorTime&quot;: &quot;A String&quot;, # The time when the error occurred.
513 &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.
514 &quot;message&quot;: &quot;A String&quot;, # A message containing more information about the error that occurred.
515 &quot;reason&quot;: &quot;A String&quot;, # A title that explains the reason for the error.
516 },
517 ],
518 &quot;eventFilter&quot;: { # Represents a filter for included data on a stream object. # Output only. The filter for performing a partial backfill.
519 &quot;sqlWhereClause&quot;: &quot;A String&quot;, # An SQL-query Where clause selecting which data should be included, not including the &quot;WHERE&quot; keyword. e.g., `t.key1 = &#x27;value1&#x27; AND t.key2 = &#x27;value2&#x27;`
520 },
521 &quot;lastEndTime&quot;: &quot;A String&quot;, # Output only. Backfill job&#x27;s end time.
522 &quot;lastStartTime&quot;: &quot;A String&quot;, # Output only. Backfill job&#x27;s start time.
523 &quot;state&quot;: &quot;A String&quot;, # Output only. Backfill job state.
524 &quot;trigger&quot;: &quot;A String&quot;, # Backfill job&#x27;s triggering reason.
525 },
526 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The creation time of the object.
527 &quot;customizationRules&quot;: [ # Output only. The customization rules for the object. These rules are derived from the parent Stream&#x27;s `rule_sets` and represent the intended configuration for the object.
528 { # A customization rule to apply to a set of objects.
529 &quot;bigqueryClustering&quot;: { # BigQuery clustering configuration. # BigQuery clustering rule.
530 &quot;columns&quot;: [ # Required. Column names to set as clustering columns.
531 &quot;A String&quot;,
532 ],
533 },
534 &quot;bigqueryPartitioning&quot;: { # BigQuery partitioning configuration. # BigQuery partitioning rule.
535 &quot;ingestionTimePartition&quot;: { # Ingestion time partitioning. see https://cloud.google.com/bigquery/docs/partitioned-tables#ingestion_time # Ingestion time partitioning.
536 &quot;partitioningTimeGranularity&quot;: &quot;A String&quot;, # Optional. Partition granularity
537 },
538 &quot;integerRangePartition&quot;: { # Integer range partitioning. see https://cloud.google.com/bigquery/docs/partitioned-tables#integer_range # Integer range partitioning.
539 &quot;column&quot;: &quot;A String&quot;, # Required. The partitioning column.
540 &quot;end&quot;: &quot;A String&quot;, # Required. The ending value for range partitioning (exclusive).
541 &quot;interval&quot;: &quot;A String&quot;, # Required. The interval of each range within the partition.
542 &quot;start&quot;: &quot;A String&quot;, # Required. The starting value for range partitioning (inclusive).
543 },
544 &quot;requirePartitionFilter&quot;: True or False, # Optional. If true, queries over the table require a partition filter.
545 &quot;timeUnitPartition&quot;: { # Time unit column partitioning. see https://cloud.google.com/bigquery/docs/partitioned-tables#date_timestamp_partitioned_tables # Time unit column partitioning.
546 &quot;column&quot;: &quot;A String&quot;, # Required. The partitioning column.
547 &quot;partitioningTimeGranularity&quot;: &quot;A String&quot;, # Optional. Partition granularity.
548 },
549 },
550 },
551 ],
552 &quot;displayName&quot;: &quot;A String&quot;, # Required. Display name.
553 &quot;errors&quot;: [ # Output only. Active errors on the object.
554 { # Represent a user-facing Error.
555 &quot;details&quot;: { # Additional information about the error.
556 &quot;a_key&quot;: &quot;A String&quot;,
557 },
558 &quot;errorTime&quot;: &quot;A String&quot;, # The time when the error occurred.
559 &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.
560 &quot;message&quot;: &quot;A String&quot;, # A message containing more information about the error that occurred.
561 &quot;reason&quot;: &quot;A String&quot;, # A title that explains the reason for the error.
562 },
563 ],
564 &quot;name&quot;: &quot;A String&quot;, # Output only. Identifier. The object resource&#x27;s name.
565 &quot;sourceObject&quot;: { # Represents an identifier of an object in the data source. # The object identifier in the data source.
566 &quot;mongodbIdentifier&quot;: { # MongoDB data source object identifier. # MongoDB data source object identifier.
567 &quot;collection&quot;: &quot;A String&quot;, # Required. The collection name.
568 &quot;database&quot;: &quot;A String&quot;, # Required. The database name.
569 },
570 &quot;mysqlIdentifier&quot;: { # Mysql data source object identifier. # Mysql data source object identifier.
571 &quot;database&quot;: &quot;A String&quot;, # Required. The database name.
572 &quot;table&quot;: &quot;A String&quot;, # Required. The table name.
573 },
574 &quot;oracleIdentifier&quot;: { # Oracle data source object identifier. # Oracle data source object identifier.
575 &quot;schema&quot;: &quot;A String&quot;, # Required. The schema name.
576 &quot;table&quot;: &quot;A String&quot;, # Required. The table name.
577 },
578 &quot;postgresqlIdentifier&quot;: { # PostgreSQL data source object identifier. # PostgreSQL data source object identifier.
579 &quot;schema&quot;: &quot;A String&quot;, # Required. The schema name.
580 &quot;table&quot;: &quot;A String&quot;, # Required. The table name.
581 },
582 &quot;salesforceIdentifier&quot;: { # Salesforce data source object identifier. # Salesforce data source object identifier.
583 &quot;objectName&quot;: &quot;A String&quot;, # Required. The object name.
584 },
585 &quot;spannerIdentifier&quot;: { # Spanner data source object identifier. # Spanner data source object identifier.
586 &quot;schema&quot;: &quot;A String&quot;, # Optional. The schema name.
587 &quot;table&quot;: &quot;A String&quot;, # Required. The table name.
588 },
589 &quot;sqlServerIdentifier&quot;: { # SQLServer data source object identifier. # SQLServer data source object identifier.
590 &quot;schema&quot;: &quot;A String&quot;, # Required. The schema name.
591 &quot;table&quot;: &quot;A String&quot;, # Required. The table name.
592 },
593 },
594 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The last update time of the object.
595 },
596 }</pre>
597 </div>
598
599 <div class="method">
600 <code class="details" id="stopBackfillJob">stopBackfillJob(object, body=None, x__xgafv=None)</code>
601 <pre>Use this method to stop a backfill job for the specified stream object.
602
603 Args:
604 object: string, Required. The name of the stream object resource to stop the backfill job for. (required)
605 body: object, The request body.
606 The object takes the form of:
607
608 { # Request for manually stopping a running backfill job for a specific stream object.
609 }
610
611 x__xgafv: string, V1 error format.
612 Allowed values
613 1 - v1 error format
614 2 - v2 error format
615
616 Returns:
617 An object of the form:
618
619 { # Response for manually stop a backfill job for a specific stream object.
620 &quot;object&quot;: { # A specific stream object (e.g a specific DB table). # The stream object resource the backfill job was stopped for.
621 &quot;backfillJob&quot;: { # Represents a backfill job on a specific stream object. # The latest backfill job that was initiated for the stream object.
622 &quot;errors&quot;: [ # Output only. Errors which caused the backfill job to fail.
623 { # Represent a user-facing Error.
624 &quot;details&quot;: { # Additional information about the error.
625 &quot;a_key&quot;: &quot;A String&quot;,
626 },
627 &quot;errorTime&quot;: &quot;A String&quot;, # The time when the error occurred.
628 &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.
629 &quot;message&quot;: &quot;A String&quot;, # A message containing more information about the error that occurred.
630 &quot;reason&quot;: &quot;A String&quot;, # A title that explains the reason for the error.
631 },
632 ],
633 &quot;eventFilter&quot;: { # Represents a filter for included data on a stream object. # Output only. The filter for performing a partial backfill.
634 &quot;sqlWhereClause&quot;: &quot;A String&quot;, # An SQL-query Where clause selecting which data should be included, not including the &quot;WHERE&quot; keyword. e.g., `t.key1 = &#x27;value1&#x27; AND t.key2 = &#x27;value2&#x27;`
635 },
636 &quot;lastEndTime&quot;: &quot;A String&quot;, # Output only. Backfill job&#x27;s end time.
637 &quot;lastStartTime&quot;: &quot;A String&quot;, # Output only. Backfill job&#x27;s start time.
638 &quot;state&quot;: &quot;A String&quot;, # Output only. Backfill job state.
639 &quot;trigger&quot;: &quot;A String&quot;, # Backfill job&#x27;s triggering reason.
640 },
641 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The creation time of the object.
642 &quot;customizationRules&quot;: [ # Output only. The customization rules for the object. These rules are derived from the parent Stream&#x27;s `rule_sets` and represent the intended configuration for the object.
643 { # A customization rule to apply to a set of objects.
644 &quot;bigqueryClustering&quot;: { # BigQuery clustering configuration. # BigQuery clustering rule.
645 &quot;columns&quot;: [ # Required. Column names to set as clustering columns.
646 &quot;A String&quot;,
647 ],
648 },
649 &quot;bigqueryPartitioning&quot;: { # BigQuery partitioning configuration. # BigQuery partitioning rule.
650 &quot;ingestionTimePartition&quot;: { # Ingestion time partitioning. see https://cloud.google.com/bigquery/docs/partitioned-tables#ingestion_time # Ingestion time partitioning.
651 &quot;partitioningTimeGranularity&quot;: &quot;A String&quot;, # Optional. Partition granularity
652 },
653 &quot;integerRangePartition&quot;: { # Integer range partitioning. see https://cloud.google.com/bigquery/docs/partitioned-tables#integer_range # Integer range partitioning.
654 &quot;column&quot;: &quot;A String&quot;, # Required. The partitioning column.
655 &quot;end&quot;: &quot;A String&quot;, # Required. The ending value for range partitioning (exclusive).
656 &quot;interval&quot;: &quot;A String&quot;, # Required. The interval of each range within the partition.
657 &quot;start&quot;: &quot;A String&quot;, # Required. The starting value for range partitioning (inclusive).
658 },
659 &quot;requirePartitionFilter&quot;: True or False, # Optional. If true, queries over the table require a partition filter.
660 &quot;timeUnitPartition&quot;: { # Time unit column partitioning. see https://cloud.google.com/bigquery/docs/partitioned-tables#date_timestamp_partitioned_tables # Time unit column partitioning.
661 &quot;column&quot;: &quot;A String&quot;, # Required. The partitioning column.
662 &quot;partitioningTimeGranularity&quot;: &quot;A String&quot;, # Optional. Partition granularity.
663 },
664 },
665 },
666 ],
667 &quot;displayName&quot;: &quot;A String&quot;, # Required. Display name.
668 &quot;errors&quot;: [ # Output only. Active errors on the object.
669 { # Represent a user-facing Error.
670 &quot;details&quot;: { # Additional information about the error.
671 &quot;a_key&quot;: &quot;A String&quot;,
672 },
673 &quot;errorTime&quot;: &quot;A String&quot;, # The time when the error occurred.
674 &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.
675 &quot;message&quot;: &quot;A String&quot;, # A message containing more information about the error that occurred.
676 &quot;reason&quot;: &quot;A String&quot;, # A title that explains the reason for the error.
677 },
678 ],
679 &quot;name&quot;: &quot;A String&quot;, # Output only. Identifier. The object resource&#x27;s name.
680 &quot;sourceObject&quot;: { # Represents an identifier of an object in the data source. # The object identifier in the data source.
681 &quot;mongodbIdentifier&quot;: { # MongoDB data source object identifier. # MongoDB data source object identifier.
682 &quot;collection&quot;: &quot;A String&quot;, # Required. The collection name.
683 &quot;database&quot;: &quot;A String&quot;, # Required. The database name.
684 },
685 &quot;mysqlIdentifier&quot;: { # Mysql data source object identifier. # Mysql data source object identifier.
686 &quot;database&quot;: &quot;A String&quot;, # Required. The database name.
687 &quot;table&quot;: &quot;A String&quot;, # Required. The table name.
688 },
689 &quot;oracleIdentifier&quot;: { # Oracle data source object identifier. # Oracle data source object identifier.
690 &quot;schema&quot;: &quot;A String&quot;, # Required. The schema name.
691 &quot;table&quot;: &quot;A String&quot;, # Required. The table name.
692 },
693 &quot;postgresqlIdentifier&quot;: { # PostgreSQL data source object identifier. # PostgreSQL data source object identifier.
694 &quot;schema&quot;: &quot;A String&quot;, # Required. The schema name.
695 &quot;table&quot;: &quot;A String&quot;, # Required. The table name.
696 },
697 &quot;salesforceIdentifier&quot;: { # Salesforce data source object identifier. # Salesforce data source object identifier.
698 &quot;objectName&quot;: &quot;A String&quot;, # Required. The object name.
699 },
700 &quot;spannerIdentifier&quot;: { # Spanner data source object identifier. # Spanner data source object identifier.
701 &quot;schema&quot;: &quot;A String&quot;, # Optional. The schema name.
702 &quot;table&quot;: &quot;A String&quot;, # Required. The table name.
703 },
704 &quot;sqlServerIdentifier&quot;: { # SQLServer data source object identifier. # SQLServer data source object identifier.
705 &quot;schema&quot;: &quot;A String&quot;, # Required. The schema name.
706 &quot;table&quot;: &quot;A String&quot;, # Required. The table name.
707 },
708 },
709 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The last update time of the object.
710 },
711 }</pre>
712 </div>
713
714 </body></html>