| 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 |
"backfillJob": { # Represents a backfill job on a specific stream object. # The latest backfill job that was initiated for the stream object. |
| 120 |
"errors": [ # Output only. Errors which caused the backfill job to fail. |
| 121 |
{ # Represent a user-facing Error. |
| 122 |
"details": { # Additional information about the error. |
| 123 |
"a_key": "A String", |
| 124 |
}, |
| 125 |
"errorTime": "A String", # The time when the error occurred. |
| 126 |
"errorUuid": "A String", # A unique identifier for this specific error, allowing it to be traced throughout the system in logs and API responses. |
| 127 |
"message": "A String", # A message containing more information about the error that occurred. |
| 128 |
"reason": "A String", # A title that explains the reason for the error. |
| 129 |
}, |
| 130 |
], |
| 131 |
"eventFilter": { # Represents a filter for included data on a stream object. # Output only. The filter for performing a partial backfill. |
| 132 |
"sqlWhereClause": "A String", # An SQL-query Where clause selecting which data should be included, not including the "WHERE" keyword. e.g., `t.key1 = 'value1' AND t.key2 = 'value2'` |
| 133 |
}, |
| 134 |
"lastEndTime": "A String", # Output only. Backfill job's end time. |
| 135 |
"lastStartTime": "A String", # Output only. Backfill job's start time. |
| 136 |
"state": "A String", # Output only. Backfill job state. |
| 137 |
"trigger": "A String", # Backfill job's triggering reason. |
| 138 |
}, |
| 139 |
"createTime": "A String", # Output only. The creation time of the object. |
| 140 |
"customizationRules": [ # Output only. The customization rules for the object. These rules are derived from the parent Stream's `rule_sets` and represent the intended configuration for the object. |
| 141 |
{ # A customization rule to apply to a set of objects. |
| 142 |
"bigqueryClustering": { # BigQuery clustering configuration. # BigQuery clustering rule. |
| 143 |
"columns": [ # Required. Column names to set as clustering columns. |
| 144 |
"A String", |
| 145 |
], |
| 146 |
}, |
| 147 |
"bigqueryPartitioning": { # BigQuery partitioning configuration. # BigQuery partitioning rule. |
| 148 |
"ingestionTimePartition": { # Ingestion time partitioning. see https://cloud.google.com/bigquery/docs/partitioned-tables#ingestion_time # Ingestion time partitioning. |
| 149 |
"partitioningTimeGranularity": "A String", # Optional. Partition granularity |
| 150 |
}, |
| 151 |
"integerRangePartition": { # Integer range partitioning. see https://cloud.google.com/bigquery/docs/partitioned-tables#integer_range # Integer range partitioning. |
| 152 |
"column": "A String", # Required. The partitioning column. |
| 153 |
"end": "A String", # Required. The ending value for range partitioning (exclusive). |
| 154 |
"interval": "A String", # Required. The interval of each range within the partition. |
| 155 |
"start": "A String", # Required. The starting value for range partitioning (inclusive). |
| 156 |
}, |
| 157 |
"requirePartitionFilter": True or False, # Optional. If true, queries over the table require a partition filter. |
| 158 |
"timeUnitPartition": { # Time unit column partitioning. see https://cloud.google.com/bigquery/docs/partitioned-tables#date_timestamp_partitioned_tables # Time unit column partitioning. |
| 159 |
"column": "A String", # Required. The partitioning column. |
| 160 |
"partitioningTimeGranularity": "A String", # Optional. Partition granularity. |
| 161 |
}, |
| 162 |
}, |
| 163 |
}, |
| 164 |
], |
| 165 |
"displayName": "A String", # Required. Display name. |
| 166 |
"errors": [ # Output only. Active errors on the object. |
| 167 |
{ # Represent a user-facing Error. |
| 168 |
"details": { # Additional information about the error. |
| 169 |
"a_key": "A String", |
| 170 |
}, |
| 171 |
"errorTime": "A String", # The time when the error occurred. |
| 172 |
"errorUuid": "A String", # A unique identifier for this specific error, allowing it to be traced throughout the system in logs and API responses. |
| 173 |
"message": "A String", # A message containing more information about the error that occurred. |
| 174 |
"reason": "A String", # A title that explains the reason for the error. |
| 175 |
}, |
| 176 |
], |
| 177 |
"name": "A String", # Output only. Identifier. The object resource's name. |
| 178 |
"sourceObject": { # Represents an identifier of an object in the data source. # The object identifier in the data source. |
| 179 |
"mongodbIdentifier": { # MongoDB data source object identifier. # MongoDB data source object identifier. |
| 180 |
"collection": "A String", # Required. The collection name. |
| 181 |
"database": "A String", # Required. The database name. |
| 182 |
}, |
| 183 |
"mysqlIdentifier": { # Mysql data source object identifier. # Mysql data source object identifier. |
| 184 |
"database": "A String", # Required. The database name. |
| 185 |
"table": "A String", # Required. The table name. |
| 186 |
}, |
| 187 |
"oracleIdentifier": { # Oracle data source object identifier. # Oracle data source object identifier. |
| 188 |
"schema": "A String", # Required. The schema name. |
| 189 |
"table": "A String", # Required. The table name. |
| 190 |
}, |
| 191 |
"postgresqlIdentifier": { # PostgreSQL data source object identifier. # PostgreSQL data source object identifier. |
| 192 |
"schema": "A String", # Required. The schema name. |
| 193 |
"table": "A String", # Required. The table name. |
| 194 |
}, |
| 195 |
"salesforceIdentifier": { # Salesforce data source object identifier. # Salesforce data source object identifier. |
| 196 |
"objectName": "A String", # Required. The object name. |
| 197 |
}, |
| 198 |
"spannerIdentifier": { # Spanner data source object identifier. # Spanner data source object identifier. |
| 199 |
"schema": "A String", # Optional. The schema name. |
| 200 |
"table": "A String", # Required. The table name. |
| 201 |
}, |
| 202 |
"sqlServerIdentifier": { # SQLServer data source object identifier. # SQLServer data source object identifier. |
| 203 |
"schema": "A String", # Required. The schema name. |
| 204 |
"table": "A String", # Required. The table name. |
| 205 |
}, |
| 206 |
}, |
| 207 |
"updateTime": "A String", # 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 |
"nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. |
| 229 |
"streamObjects": [ # List of stream objects. |
| 230 |
{ # A specific stream object (e.g a specific DB table). |
| 231 |
"backfillJob": { # Represents a backfill job on a specific stream object. # The latest backfill job that was initiated for the stream object. |
| 232 |
"errors": [ # Output only. Errors which caused the backfill job to fail. |
| 233 |
{ # Represent a user-facing Error. |
| 234 |
"details": { # Additional information about the error. |
| 235 |
"a_key": "A String", |
| 236 |
}, |
| 237 |
"errorTime": "A String", # The time when the error occurred. |
| 238 |
"errorUuid": "A String", # A unique identifier for this specific error, allowing it to be traced throughout the system in logs and API responses. |
| 239 |
"message": "A String", # A message containing more information about the error that occurred. |
| 240 |
"reason": "A String", # A title that explains the reason for the error. |
| 241 |
}, |
| 242 |
], |
| 243 |
"eventFilter": { # Represents a filter for included data on a stream object. # Output only. The filter for performing a partial backfill. |
| 244 |
"sqlWhereClause": "A String", # An SQL-query Where clause selecting which data should be included, not including the "WHERE" keyword. e.g., `t.key1 = 'value1' AND t.key2 = 'value2'` |
| 245 |
}, |
| 246 |
"lastEndTime": "A String", # Output only. Backfill job's end time. |
| 247 |
"lastStartTime": "A String", # Output only. Backfill job's start time. |
| 248 |
"state": "A String", # Output only. Backfill job state. |
| 249 |
"trigger": "A String", # Backfill job's triggering reason. |
| 250 |
}, |
| 251 |
"createTime": "A String", # Output only. The creation time of the object. |
| 252 |
"customizationRules": [ # Output only. The customization rules for the object. These rules are derived from the parent Stream's `rule_sets` and represent the intended configuration for the object. |
| 253 |
{ # A customization rule to apply to a set of objects. |
| 254 |
"bigqueryClustering": { # BigQuery clustering configuration. # BigQuery clustering rule. |
| 255 |
"columns": [ # Required. Column names to set as clustering columns. |
| 256 |
"A String", |
| 257 |
], |
| 258 |
}, |
| 259 |
"bigqueryPartitioning": { # BigQuery partitioning configuration. # BigQuery partitioning rule. |
| 260 |
"ingestionTimePartition": { # Ingestion time partitioning. see https://cloud.google.com/bigquery/docs/partitioned-tables#ingestion_time # Ingestion time partitioning. |
| 261 |
"partitioningTimeGranularity": "A String", # Optional. Partition granularity |
| 262 |
}, |
| 263 |
"integerRangePartition": { # Integer range partitioning. see https://cloud.google.com/bigquery/docs/partitioned-tables#integer_range # Integer range partitioning. |
| 264 |
"column": "A String", # Required. The partitioning column. |
| 265 |
"end": "A String", # Required. The ending value for range partitioning (exclusive). |
| 266 |
"interval": "A String", # Required. The interval of each range within the partition. |
| 267 |
"start": "A String", # Required. The starting value for range partitioning (inclusive). |
| 268 |
}, |
| 269 |
"requirePartitionFilter": True or False, # Optional. If true, queries over the table require a partition filter. |
| 270 |
"timeUnitPartition": { # Time unit column partitioning. see https://cloud.google.com/bigquery/docs/partitioned-tables#date_timestamp_partitioned_tables # Time unit column partitioning. |
| 271 |
"column": "A String", # Required. The partitioning column. |
| 272 |
"partitioningTimeGranularity": "A String", # Optional. Partition granularity. |
| 273 |
}, |
| 274 |
}, |
| 275 |
}, |
| 276 |
], |
| 277 |
"displayName": "A String", # Required. Display name. |
| 278 |
"errors": [ # Output only. Active errors on the object. |
| 279 |
{ # Represent a user-facing Error. |
| 280 |
"details": { # Additional information about the error. |
| 281 |
"a_key": "A String", |
| 282 |
}, |
| 283 |
"errorTime": "A String", # The time when the error occurred. |
| 284 |
"errorUuid": "A String", # A unique identifier for this specific error, allowing it to be traced throughout the system in logs and API responses. |
| 285 |
"message": "A String", # A message containing more information about the error that occurred. |
| 286 |
"reason": "A String", # A title that explains the reason for the error. |
| 287 |
}, |
| 288 |
], |
| 289 |
"name": "A String", # Output only. Identifier. The object resource's name. |
| 290 |
"sourceObject": { # Represents an identifier of an object in the data source. # The object identifier in the data source. |
| 291 |
"mongodbIdentifier": { # MongoDB data source object identifier. # MongoDB data source object identifier. |
| 292 |
"collection": "A String", # Required. The collection name. |
| 293 |
"database": "A String", # Required. The database name. |
| 294 |
}, |
| 295 |
"mysqlIdentifier": { # Mysql data source object identifier. # Mysql data source object identifier. |
| 296 |
"database": "A String", # Required. The database name. |
| 297 |
"table": "A String", # Required. The table name. |
| 298 |
}, |
| 299 |
"oracleIdentifier": { # Oracle data source object identifier. # Oracle data source object identifier. |
| 300 |
"schema": "A String", # Required. The schema name. |
| 301 |
"table": "A String", # Required. The table name. |
| 302 |
}, |
| 303 |
"postgresqlIdentifier": { # PostgreSQL data source object identifier. # PostgreSQL data source object identifier. |
| 304 |
"schema": "A String", # Required. The schema name. |
| 305 |
"table": "A String", # Required. The table name. |
| 306 |
}, |
| 307 |
"salesforceIdentifier": { # Salesforce data source object identifier. # Salesforce data source object identifier. |
| 308 |
"objectName": "A String", # Required. The object name. |
| 309 |
}, |
| 310 |
"spannerIdentifier": { # Spanner data source object identifier. # Spanner data source object identifier. |
| 311 |
"schema": "A String", # Optional. The schema name. |
| 312 |
"table": "A String", # Required. The table name. |
| 313 |
}, |
| 314 |
"sqlServerIdentifier": { # SQLServer data source object identifier. # SQLServer data source object identifier. |
| 315 |
"schema": "A String", # Required. The schema name. |
| 316 |
"table": "A String", # Required. The table name. |
| 317 |
}, |
| 318 |
}, |
| 319 |
"updateTime": "A String", # 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 'execute()' 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 |
"sourceObjectIdentifier": { # Represents an identifier of an object in the data source. # Required. The source object identifier which maps to the stream object. |
| 350 |
"mongodbIdentifier": { # MongoDB data source object identifier. # MongoDB data source object identifier. |
| 351 |
"collection": "A String", # Required. The collection name. |
| 352 |
"database": "A String", # Required. The database name. |
| 353 |
}, |
| 354 |
"mysqlIdentifier": { # Mysql data source object identifier. # Mysql data source object identifier. |
| 355 |
"database": "A String", # Required. The database name. |
| 356 |
"table": "A String", # Required. The table name. |
| 357 |
}, |
| 358 |
"oracleIdentifier": { # Oracle data source object identifier. # Oracle data source object identifier. |
| 359 |
"schema": "A String", # Required. The schema name. |
| 360 |
"table": "A String", # Required. The table name. |
| 361 |
}, |
| 362 |
"postgresqlIdentifier": { # PostgreSQL data source object identifier. # PostgreSQL data source object identifier. |
| 363 |
"schema": "A String", # Required. The schema name. |
| 364 |
"table": "A String", # Required. The table name. |
| 365 |
}, |
| 366 |
"salesforceIdentifier": { # Salesforce data source object identifier. # Salesforce data source object identifier. |
| 367 |
"objectName": "A String", # Required. The object name. |
| 368 |
}, |
| 369 |
"spannerIdentifier": { # Spanner data source object identifier. # Spanner data source object identifier. |
| 370 |
"schema": "A String", # Optional. The schema name. |
| 371 |
"table": "A String", # Required. The table name. |
| 372 |
}, |
| 373 |
"sqlServerIdentifier": { # SQLServer data source object identifier. # SQLServer data source object identifier. |
| 374 |
"schema": "A String", # Required. The schema name. |
| 375 |
"table": "A String", # 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 |
"backfillJob": { # Represents a backfill job on a specific stream object. # The latest backfill job that was initiated for the stream object. |
| 390 |
"errors": [ # Output only. Errors which caused the backfill job to fail. |
| 391 |
{ # Represent a user-facing Error. |
| 392 |
"details": { # Additional information about the error. |
| 393 |
"a_key": "A String", |
| 394 |
}, |
| 395 |
"errorTime": "A String", # The time when the error occurred. |
| 396 |
"errorUuid": "A String", # A unique identifier for this specific error, allowing it to be traced throughout the system in logs and API responses. |
| 397 |
"message": "A String", # A message containing more information about the error that occurred. |
| 398 |
"reason": "A String", # A title that explains the reason for the error. |
| 399 |
}, |
| 400 |
], |
| 401 |
"eventFilter": { # Represents a filter for included data on a stream object. # Output only. The filter for performing a partial backfill. |
| 402 |
"sqlWhereClause": "A String", # An SQL-query Where clause selecting which data should be included, not including the "WHERE" keyword. e.g., `t.key1 = 'value1' AND t.key2 = 'value2'` |
| 403 |
}, |
| 404 |
"lastEndTime": "A String", # Output only. Backfill job's end time. |
| 405 |
"lastStartTime": "A String", # Output only. Backfill job's start time. |
| 406 |
"state": "A String", # Output only. Backfill job state. |
| 407 |
"trigger": "A String", # Backfill job's triggering reason. |
| 408 |
}, |
| 409 |
"createTime": "A String", # Output only. The creation time of the object. |
| 410 |
"customizationRules": [ # Output only. The customization rules for the object. These rules are derived from the parent Stream's `rule_sets` and represent the intended configuration for the object. |
| 411 |
{ # A customization rule to apply to a set of objects. |
| 412 |
"bigqueryClustering": { # BigQuery clustering configuration. # BigQuery clustering rule. |
| 413 |
"columns": [ # Required. Column names to set as clustering columns. |
| 414 |
"A String", |
| 415 |
], |
| 416 |
}, |
| 417 |
"bigqueryPartitioning": { # BigQuery partitioning configuration. # BigQuery partitioning rule. |
| 418 |
"ingestionTimePartition": { # Ingestion time partitioning. see https://cloud.google.com/bigquery/docs/partitioned-tables#ingestion_time # Ingestion time partitioning. |
| 419 |
"partitioningTimeGranularity": "A String", # Optional. Partition granularity |
| 420 |
}, |
| 421 |
"integerRangePartition": { # Integer range partitioning. see https://cloud.google.com/bigquery/docs/partitioned-tables#integer_range # Integer range partitioning. |
| 422 |
"column": "A String", # Required. The partitioning column. |
| 423 |
"end": "A String", # Required. The ending value for range partitioning (exclusive). |
| 424 |
"interval": "A String", # Required. The interval of each range within the partition. |
| 425 |
"start": "A String", # Required. The starting value for range partitioning (inclusive). |
| 426 |
}, |
| 427 |
"requirePartitionFilter": True or False, # Optional. If true, queries over the table require a partition filter. |
| 428 |
"timeUnitPartition": { # Time unit column partitioning. see https://cloud.google.com/bigquery/docs/partitioned-tables#date_timestamp_partitioned_tables # Time unit column partitioning. |
| 429 |
"column": "A String", # Required. The partitioning column. |
| 430 |
"partitioningTimeGranularity": "A String", # Optional. Partition granularity. |
| 431 |
}, |
| 432 |
}, |
| 433 |
}, |
| 434 |
], |
| 435 |
"displayName": "A String", # Required. Display name. |
| 436 |
"errors": [ # Output only. Active errors on the object. |
| 437 |
{ # Represent a user-facing Error. |
| 438 |
"details": { # Additional information about the error. |
| 439 |
"a_key": "A String", |
| 440 |
}, |
| 441 |
"errorTime": "A String", # The time when the error occurred. |
| 442 |
"errorUuid": "A String", # A unique identifier for this specific error, allowing it to be traced throughout the system in logs and API responses. |
| 443 |
"message": "A String", # A message containing more information about the error that occurred. |
| 444 |
"reason": "A String", # A title that explains the reason for the error. |
| 445 |
}, |
| 446 |
], |
| 447 |
"name": "A String", # Output only. Identifier. The object resource's name. |
| 448 |
"sourceObject": { # Represents an identifier of an object in the data source. # The object identifier in the data source. |
| 449 |
"mongodbIdentifier": { # MongoDB data source object identifier. # MongoDB data source object identifier. |
| 450 |
"collection": "A String", # Required. The collection name. |
| 451 |
"database": "A String", # Required. The database name. |
| 452 |
}, |
| 453 |
"mysqlIdentifier": { # Mysql data source object identifier. # Mysql data source object identifier. |
| 454 |
"database": "A String", # Required. The database name. |
| 455 |
"table": "A String", # Required. The table name. |
| 456 |
}, |
| 457 |
"oracleIdentifier": { # Oracle data source object identifier. # Oracle data source object identifier. |
| 458 |
"schema": "A String", # Required. The schema name. |
| 459 |
"table": "A String", # Required. The table name. |
| 460 |
}, |
| 461 |
"postgresqlIdentifier": { # PostgreSQL data source object identifier. # PostgreSQL data source object identifier. |
| 462 |
"schema": "A String", # Required. The schema name. |
| 463 |
"table": "A String", # Required. The table name. |
| 464 |
}, |
| 465 |
"salesforceIdentifier": { # Salesforce data source object identifier. # Salesforce data source object identifier. |
| 466 |
"objectName": "A String", # Required. The object name. |
| 467 |
}, |
| 468 |
"spannerIdentifier": { # Spanner data source object identifier. # Spanner data source object identifier. |
| 469 |
"schema": "A String", # Optional. The schema name. |
| 470 |
"table": "A String", # Required. The table name. |
| 471 |
}, |
| 472 |
"sqlServerIdentifier": { # SQLServer data source object identifier. # SQLServer data source object identifier. |
| 473 |
"schema": "A String", # Required. The schema name. |
| 474 |
"table": "A String", # Required. The table name. |
| 475 |
}, |
| 476 |
}, |
| 477 |
"updateTime": "A String", # 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 |
"eventFilter": { # 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 |
"sqlWhereClause": "A String", # An SQL-query Where clause selecting which data should be included, not including the "WHERE" keyword. e.g., `t.key1 = 'value1' AND t.key2 = 'value2'` |
| 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 |
"object": { # A specific stream object (e.g a specific DB table). # The stream object resource a backfill job was started for. |
| 506 |
"backfillJob": { # Represents a backfill job on a specific stream object. # The latest backfill job that was initiated for the stream object. |
| 507 |
"errors": [ # Output only. Errors which caused the backfill job to fail. |
| 508 |
{ # Represent a user-facing Error. |
| 509 |
"details": { # Additional information about the error. |
| 510 |
"a_key": "A String", |
| 511 |
}, |
| 512 |
"errorTime": "A String", # The time when the error occurred. |
| 513 |
"errorUuid": "A String", # A unique identifier for this specific error, allowing it to be traced throughout the system in logs and API responses. |
| 514 |
"message": "A String", # A message containing more information about the error that occurred. |
| 515 |
"reason": "A String", # A title that explains the reason for the error. |
| 516 |
}, |
| 517 |
], |
| 518 |
"eventFilter": { # Represents a filter for included data on a stream object. # Output only. The filter for performing a partial backfill. |
| 519 |
"sqlWhereClause": "A String", # An SQL-query Where clause selecting which data should be included, not including the "WHERE" keyword. e.g., `t.key1 = 'value1' AND t.key2 = 'value2'` |
| 520 |
}, |
| 521 |
"lastEndTime": "A String", # Output only. Backfill job's end time. |
| 522 |
"lastStartTime": "A String", # Output only. Backfill job's start time. |
| 523 |
"state": "A String", # Output only. Backfill job state. |
| 524 |
"trigger": "A String", # Backfill job's triggering reason. |
| 525 |
}, |
| 526 |
"createTime": "A String", # Output only. The creation time of the object. |
| 527 |
"customizationRules": [ # Output only. The customization rules for the object. These rules are derived from the parent Stream's `rule_sets` and represent the intended configuration for the object. |
| 528 |
{ # A customization rule to apply to a set of objects. |
| 529 |
"bigqueryClustering": { # BigQuery clustering configuration. # BigQuery clustering rule. |
| 530 |
"columns": [ # Required. Column names to set as clustering columns. |
| 531 |
"A String", |
| 532 |
], |
| 533 |
}, |
| 534 |
"bigqueryPartitioning": { # BigQuery partitioning configuration. # BigQuery partitioning rule. |
| 535 |
"ingestionTimePartition": { # Ingestion time partitioning. see https://cloud.google.com/bigquery/docs/partitioned-tables#ingestion_time # Ingestion time partitioning. |
| 536 |
"partitioningTimeGranularity": "A String", # Optional. Partition granularity |
| 537 |
}, |
| 538 |
"integerRangePartition": { # Integer range partitioning. see https://cloud.google.com/bigquery/docs/partitioned-tables#integer_range # Integer range partitioning. |
| 539 |
"column": "A String", # Required. The partitioning column. |
| 540 |
"end": "A String", # Required. The ending value for range partitioning (exclusive). |
| 541 |
"interval": "A String", # Required. The interval of each range within the partition. |
| 542 |
"start": "A String", # Required. The starting value for range partitioning (inclusive). |
| 543 |
}, |
| 544 |
"requirePartitionFilter": True or False, # Optional. If true, queries over the table require a partition filter. |
| 545 |
"timeUnitPartition": { # Time unit column partitioning. see https://cloud.google.com/bigquery/docs/partitioned-tables#date_timestamp_partitioned_tables # Time unit column partitioning. |
| 546 |
"column": "A String", # Required. The partitioning column. |
| 547 |
"partitioningTimeGranularity": "A String", # Optional. Partition granularity. |
| 548 |
}, |
| 549 |
}, |
| 550 |
}, |
| 551 |
], |
| 552 |
"displayName": "A String", # Required. Display name. |
| 553 |
"errors": [ # Output only. Active errors on the object. |
| 554 |
{ # Represent a user-facing Error. |
| 555 |
"details": { # Additional information about the error. |
| 556 |
"a_key": "A String", |
| 557 |
}, |
| 558 |
"errorTime": "A String", # The time when the error occurred. |
| 559 |
"errorUuid": "A String", # A unique identifier for this specific error, allowing it to be traced throughout the system in logs and API responses. |
| 560 |
"message": "A String", # A message containing more information about the error that occurred. |
| 561 |
"reason": "A String", # A title that explains the reason for the error. |
| 562 |
}, |
| 563 |
], |
| 564 |
"name": "A String", # Output only. Identifier. The object resource's name. |
| 565 |
"sourceObject": { # Represents an identifier of an object in the data source. # The object identifier in the data source. |
| 566 |
"mongodbIdentifier": { # MongoDB data source object identifier. # MongoDB data source object identifier. |
| 567 |
"collection": "A String", # Required. The collection name. |
| 568 |
"database": "A String", # Required. The database name. |
| 569 |
}, |
| 570 |
"mysqlIdentifier": { # Mysql data source object identifier. # Mysql data source object identifier. |
| 571 |
"database": "A String", # Required. The database name. |
| 572 |
"table": "A String", # Required. The table name. |
| 573 |
}, |
| 574 |
"oracleIdentifier": { # Oracle data source object identifier. # Oracle data source object identifier. |
| 575 |
"schema": "A String", # Required. The schema name. |
| 576 |
"table": "A String", # Required. The table name. |
| 577 |
}, |
| 578 |
"postgresqlIdentifier": { # PostgreSQL data source object identifier. # PostgreSQL data source object identifier. |
| 579 |
"schema": "A String", # Required. The schema name. |
| 580 |
"table": "A String", # Required. The table name. |
| 581 |
}, |
| 582 |
"salesforceIdentifier": { # Salesforce data source object identifier. # Salesforce data source object identifier. |
| 583 |
"objectName": "A String", # Required. The object name. |
| 584 |
}, |
| 585 |
"spannerIdentifier": { # Spanner data source object identifier. # Spanner data source object identifier. |
| 586 |
"schema": "A String", # Optional. The schema name. |
| 587 |
"table": "A String", # Required. The table name. |
| 588 |
}, |
| 589 |
"sqlServerIdentifier": { # SQLServer data source object identifier. # SQLServer data source object identifier. |
| 590 |
"schema": "A String", # Required. The schema name. |
| 591 |
"table": "A String", # Required. The table name. |
| 592 |
}, |
| 593 |
}, |
| 594 |
"updateTime": "A String", # 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 |
"object": { # A specific stream object (e.g a specific DB table). # The stream object resource the backfill job was stopped for. |
| 621 |
"backfillJob": { # Represents a backfill job on a specific stream object. # The latest backfill job that was initiated for the stream object. |
| 622 |
"errors": [ # Output only. Errors which caused the backfill job to fail. |
| 623 |
{ # Represent a user-facing Error. |
| 624 |
"details": { # Additional information about the error. |
| 625 |
"a_key": "A String", |
| 626 |
}, |
| 627 |
"errorTime": "A String", # The time when the error occurred. |
| 628 |
"errorUuid": "A String", # A unique identifier for this specific error, allowing it to be traced throughout the system in logs and API responses. |
| 629 |
"message": "A String", # A message containing more information about the error that occurred. |
| 630 |
"reason": "A String", # A title that explains the reason for the error. |
| 631 |
}, |
| 632 |
], |
| 633 |
"eventFilter": { # Represents a filter for included data on a stream object. # Output only. The filter for performing a partial backfill. |
| 634 |
"sqlWhereClause": "A String", # An SQL-query Where clause selecting which data should be included, not including the "WHERE" keyword. e.g., `t.key1 = 'value1' AND t.key2 = 'value2'` |
| 635 |
}, |
| 636 |
"lastEndTime": "A String", # Output only. Backfill job's end time. |
| 637 |
"lastStartTime": "A String", # Output only. Backfill job's start time. |
| 638 |
"state": "A String", # Output only. Backfill job state. |
| 639 |
"trigger": "A String", # Backfill job's triggering reason. |
| 640 |
}, |
| 641 |
"createTime": "A String", # Output only. The creation time of the object. |
| 642 |
"customizationRules": [ # Output only. The customization rules for the object. These rules are derived from the parent Stream's `rule_sets` and represent the intended configuration for the object. |
| 643 |
{ # A customization rule to apply to a set of objects. |
| 644 |
"bigqueryClustering": { # BigQuery clustering configuration. # BigQuery clustering rule. |
| 645 |
"columns": [ # Required. Column names to set as clustering columns. |
| 646 |
"A String", |
| 647 |
], |
| 648 |
}, |
| 649 |
"bigqueryPartitioning": { # BigQuery partitioning configuration. # BigQuery partitioning rule. |
| 650 |
"ingestionTimePartition": { # Ingestion time partitioning. see https://cloud.google.com/bigquery/docs/partitioned-tables#ingestion_time # Ingestion time partitioning. |
| 651 |
"partitioningTimeGranularity": "A String", # Optional. Partition granularity |
| 652 |
}, |
| 653 |
"integerRangePartition": { # Integer range partitioning. see https://cloud.google.com/bigquery/docs/partitioned-tables#integer_range # Integer range partitioning. |
| 654 |
"column": "A String", # Required. The partitioning column. |
| 655 |
"end": "A String", # Required. The ending value for range partitioning (exclusive). |
| 656 |
"interval": "A String", # Required. The interval of each range within the partition. |
| 657 |
"start": "A String", # Required. The starting value for range partitioning (inclusive). |
| 658 |
}, |
| 659 |
"requirePartitionFilter": True or False, # Optional. If true, queries over the table require a partition filter. |
| 660 |
"timeUnitPartition": { # Time unit column partitioning. see https://cloud.google.com/bigquery/docs/partitioned-tables#date_timestamp_partitioned_tables # Time unit column partitioning. |
| 661 |
"column": "A String", # Required. The partitioning column. |
| 662 |
"partitioningTimeGranularity": "A String", # Optional. Partition granularity. |
| 663 |
}, |
| 664 |
}, |
| 665 |
}, |
| 666 |
], |
| 667 |
"displayName": "A String", # Required. Display name. |
| 668 |
"errors": [ # Output only. Active errors on the object. |
| 669 |
{ # Represent a user-facing Error. |
| 670 |
"details": { # Additional information about the error. |
| 671 |
"a_key": "A String", |
| 672 |
}, |
| 673 |
"errorTime": "A String", # The time when the error occurred. |
| 674 |
"errorUuid": "A String", # A unique identifier for this specific error, allowing it to be traced throughout the system in logs and API responses. |
| 675 |
"message": "A String", # A message containing more information about the error that occurred. |
| 676 |
"reason": "A String", # A title that explains the reason for the error. |
| 677 |
}, |
| 678 |
], |
| 679 |
"name": "A String", # Output only. Identifier. The object resource's name. |
| 680 |
"sourceObject": { # Represents an identifier of an object in the data source. # The object identifier in the data source. |
| 681 |
"mongodbIdentifier": { # MongoDB data source object identifier. # MongoDB data source object identifier. |
| 682 |
"collection": "A String", # Required. The collection name. |
| 683 |
"database": "A String", # Required. The database name. |
| 684 |
}, |
| 685 |
"mysqlIdentifier": { # Mysql data source object identifier. # Mysql data source object identifier. |
| 686 |
"database": "A String", # Required. The database name. |
| 687 |
"table": "A String", # Required. The table name. |
| 688 |
}, |
| 689 |
"oracleIdentifier": { # Oracle data source object identifier. # Oracle data source object identifier. |
| 690 |
"schema": "A String", # Required. The schema name. |
| 691 |
"table": "A String", # Required. The table name. |
| 692 |
}, |
| 693 |
"postgresqlIdentifier": { # PostgreSQL data source object identifier. # PostgreSQL data source object identifier. |
| 694 |
"schema": "A String", # Required. The schema name. |
| 695 |
"table": "A String", # Required. The table name. |
| 696 |
}, |
| 697 |
"salesforceIdentifier": { # Salesforce data source object identifier. # Salesforce data source object identifier. |
| 698 |
"objectName": "A String", # Required. The object name. |
| 699 |
}, |
| 700 |
"spannerIdentifier": { # Spanner data source object identifier. # Spanner data source object identifier. |
| 701 |
"schema": "A String", # Optional. The schema name. |
| 702 |
"table": "A String", # Required. The table name. |
| 703 |
}, |
| 704 |
"sqlServerIdentifier": { # SQLServer data source object identifier. # SQLServer data source object identifier. |
| 705 |
"schema": "A String", # Required. The schema name. |
| 706 |
"table": "A String", # Required. The table name. |
| 707 |
}, |
| 708 |
}, |
| 709 |
"updateTime": "A String", # Output only. The last update time of the object. |
| 710 |
}, |
| 711 |
}</pre> |
| 712 |
</div> |
| 713 |
|
| 714 |
</body></html> |