1<html><body> 2<style> 3 4body, h1, h2, h3, div, span, p, pre, a { 5 margin: 0; 6 padding: 0; 7 border: 0; 8 font-weight: inherit; 9 font-style: inherit; 10 font-size: 100%; 11 font-family: inherit; 12 vertical-align: baseline; 13} 14 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, h2, h3 { 50 border-bottom: solid #CCC 1px; 51} 52 53.toc_element { 54 margin-top: 0.5em; 55} 56 57.firstline { 58 margin-left: 2 em; 59} 60 61.method { 62 margin-top: 1em; 63 border: solid 1px #CCC; 64 padding: 1em; 65 background: #EEE; 66} 67 68.details { 69 font-weight: bold; 70 font-size: 14px; 71} 72 73</style> 74 75<h1><a href="datastream_v1alpha1.html">Datastream API</a> . <a href="datastream_v1alpha1.projects.html">projects</a> . <a href="datastream_v1alpha1.projects.locations.html">locations</a> . <a href="datastream_v1alpha1.projects.locations.streams.html">streams</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="datastream_v1alpha1.projects.locations.streams.objects.html">objects()</a></code> 79</p> 80<p class="firstline">Returns the objects Resource.</p> 81 82<p class="toc_element"> 83 <code><a href="#close">close()</a></code></p> 84<p class="firstline">Close httplib2 connections.</p> 85<p class="toc_element"> 86 <code><a href="#create">create(parent, body=None, force=None, requestId=None, streamId=None, validateOnly=None, x__xgafv=None)</a></code></p> 87<p class="firstline">Use this method to create a stream.</p> 88<p class="toc_element"> 89 <code><a href="#delete">delete(name, requestId=None, x__xgafv=None)</a></code></p> 90<p class="firstline">Use this method to delete a stream.</p> 91<p class="toc_element"> 92 <code><a href="#fetchErrors">fetchErrors(stream, body=None, x__xgafv=None)</a></code></p> 93<p class="firstline">Use this method to fetch any errors associated with a stream.</p> 94<p class="toc_element"> 95 <code><a href="#get">get(name, x__xgafv=None)</a></code></p> 96<p class="firstline">Use this method to get details about a stream.</p> 97<p class="toc_element"> 98 <code><a href="#list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> 99<p class="firstline">Use this method to list streams in a project and location.</p> 100<p class="toc_element"> 101 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 102<p class="firstline">Retrieves the next page of results.</p> 103<p class="toc_element"> 104 <code><a href="#patch">patch(name, body=None, force=None, requestId=None, updateMask=None, validateOnly=None, x__xgafv=None)</a></code></p> 105<p class="firstline">Use this method to update the configuration of a stream.</p> 106<h3>Method Details</h3> 107<div class="method"> 108 <code class="details" id="close">close()</code> 109 <pre>Close httplib2 connections.</pre> 110</div> 111 112<div class="method"> 113 <code class="details" id="create">create(parent, body=None, force=None, requestId=None, streamId=None, validateOnly=None, x__xgafv=None)</code> 114 <pre>Use this method to create a stream. 115 116Args: 117 parent: string, Required. The parent that owns the collection of streams. (required) 118 body: object, The request body. 119 The object takes the form of: 120 121{ 122 "backfillAll": { # Backfill strategy to automatically backfill the Stream's objects. Specific objects can be excluded. # Automatically backfill objects included in the stream source configuration. Specific objects can be excluded. 123 "mysqlExcludedObjects": { # MySQL database structure # MySQL data source objects to avoid backfilling. 124 "mysqlDatabases": [ # Mysql databases on the server 125 { # MySQL database. 126 "databaseName": "A String", # Database name. 127 "mysqlTables": [ # Tables in the database. 128 { # MySQL table. 129 "mysqlColumns": [ # MySQL columns in the database. When unspecified as part of include/exclude lists, includes/excludes everything. 130 { # MySQL Column. 131 "collation": "A String", # Column collation. 132 "columnName": "A String", # Column name. 133 "dataType": "A String", # The MySQL data type. Full data types list can be found here: https://dev.mysql.com/doc/refman/8.0/en/data-types.html 134 "length": 42, # Column length. 135 "nullable": True or False, # Whether or not the column can accept a null value. 136 "ordinalPosition": 42, # The ordinal position of the column in the table. 137 "primaryKey": True or False, # Whether or not the column represents a primary key. 138 }, 139 ], 140 "tableName": "A String", # Table name. 141 }, 142 ], 143 }, 144 ], 145 }, 146 "oracleExcludedObjects": { # Oracle database structure. # Oracle data source objects to avoid backfilling. 147 "oracleSchemas": [ # Oracle schemas/databases in the database server. 148 { # Oracle schema. 149 "oracleTables": [ # Tables in the schema. 150 { # Oracle table. 151 "oracleColumns": [ # Oracle columns in the schema. When unspecified as part of inclue/exclude lists, includes/excludes everything. 152 { # Oracle Column. 153 "columnName": "A String", # Column name. 154 "dataType": "A String", # The Oracle data type. 155 "encoding": "A String", # Column encoding. 156 "length": 42, # Column length. 157 "nullable": True or False, # Whether or not the column can accept a null value. 158 "ordinalPosition": 42, # The ordinal position of the column in the table. 159 "precision": 42, # Column precision. 160 "primaryKey": True or False, # Whether or not the column represents a primary key. 161 "scale": 42, # Column scale. 162 }, 163 ], 164 "tableName": "A String", # Table name. 165 }, 166 ], 167 "schemaName": "A String", # Schema name. 168 }, 169 ], 170 }, 171 }, 172 "backfillNone": { # Backfill strategy to disable automatic backfill for the Stream's objects. # Do not automatically backfill any objects. 173 }, 174 "createTime": "A String", # Output only. The creation time of the stream. 175 "customerManagedEncryptionKey": "A String", # Immutable. A reference to a KMS encryption key. If provided, it will be used to encrypt the data. If left blank, data will be encrypted using an internal Stream-specific encryption key provisioned through KMS. 176 "destinationConfig": { # The configuration of the stream destination. # Required. Destination connection profile configuration. 177 "destinationConnectionProfileName": "A String", # Required. Destination connection profile identifier. 178 "gcsDestinationConfig": { # Google Cloud Storage destination configuration 179 "avroFileFormat": { # AVRO file format configuration. # AVRO file format configuration. 180 }, 181 "fileRotationInterval": "A String", # The maximum duration for which new events are added before a file is closed and a new file is created. 182 "fileRotationMb": 42, # The maximum file size to be saved in the bucket. 183 "gcsFileFormat": "A String", # File format that data should be written in. Deprecated field (b/169501737) - use file_format instead. 184 "jsonFileFormat": { # JSON file format configuration. # JSON file format configuration. 185 "compression": "A String", # Compression of the loaded JSON file. 186 "schemaFileFormat": "A String", # The schema file format along JSON data files. 187 }, 188 "path": "A String", # Path inside the Cloud Storage bucket to write data to. 189 }, 190 }, 191 "displayName": "A String", # Required. Display name. 192 "errors": [ # Output only. Errors on the Stream. 193 { # Represent a user-facing Error. 194 "details": { # Additional information about the error. 195 "a_key": "A String", 196 }, 197 "errorTime": "A String", # The time when the error occurred. 198 "errorUuid": "A String", # A unique identifier for this specific error, allowing it to be traced throughout the system in logs and API responses. 199 "message": "A String", # A message containing more information about the error that occurred. 200 "reason": "A String", # A title that explains the reason for the error. 201 }, 202 ], 203 "labels": { # Labels. 204 "a_key": "A String", 205 }, 206 "name": "A String", # Output only. The stream's name. 207 "sourceConfig": { # The configuration of the stream source. # Required. Source connection profile configuration. 208 "mysqlSourceConfig": { # MySQL source configuration # MySQL data source configuration 209 "allowlist": { # MySQL database structure # MySQL objects to retrieve from the source. 210 "mysqlDatabases": [ # Mysql databases on the server 211 { # MySQL database. 212 "databaseName": "A String", # Database name. 213 "mysqlTables": [ # Tables in the database. 214 { # MySQL table. 215 "mysqlColumns": [ # MySQL columns in the database. When unspecified as part of include/exclude lists, includes/excludes everything. 216 { # MySQL Column. 217 "collation": "A String", # Column collation. 218 "columnName": "A String", # Column name. 219 "dataType": "A String", # The MySQL data type. Full data types list can be found here: https://dev.mysql.com/doc/refman/8.0/en/data-types.html 220 "length": 42, # Column length. 221 "nullable": True or False, # Whether or not the column can accept a null value. 222 "ordinalPosition": 42, # The ordinal position of the column in the table. 223 "primaryKey": True or False, # Whether or not the column represents a primary key. 224 }, 225 ], 226 "tableName": "A String", # Table name. 227 }, 228 ], 229 }, 230 ], 231 }, 232 "rejectlist": { # MySQL database structure # MySQL objects to exclude from the stream. 233 "mysqlDatabases": [ # Mysql databases on the server 234 { # MySQL database. 235 "databaseName": "A String", # Database name. 236 "mysqlTables": [ # Tables in the database. 237 { # MySQL table. 238 "mysqlColumns": [ # MySQL columns in the database. When unspecified as part of include/exclude lists, includes/excludes everything. 239 { # MySQL Column. 240 "collation": "A String", # Column collation. 241 "columnName": "A String", # Column name. 242 "dataType": "A String", # The MySQL data type. Full data types list can be found here: https://dev.mysql.com/doc/refman/8.0/en/data-types.html 243 "length": 42, # Column length. 244 "nullable": True or False, # Whether or not the column can accept a null value. 245 "ordinalPosition": 42, # The ordinal position of the column in the table. 246 "primaryKey": True or False, # Whether or not the column represents a primary key. 247 }, 248 ], 249 "tableName": "A String", # Table name. 250 }, 251 ], 252 }, 253 ], 254 }, 255 }, 256 "oracleSourceConfig": { # Oracle data source configuration # Oracle data source configuration 257 "allowlist": { # Oracle database structure. # Oracle objects to include in the stream. 258 "oracleSchemas": [ # Oracle schemas/databases in the database server. 259 { # Oracle schema. 260 "oracleTables": [ # Tables in the schema. 261 { # Oracle table. 262 "oracleColumns": [ # Oracle columns in the schema. When unspecified as part of inclue/exclude lists, includes/excludes everything. 263 { # Oracle Column. 264 "columnName": "A String", # Column name. 265 "dataType": "A String", # The Oracle data type. 266 "encoding": "A String", # Column encoding. 267 "length": 42, # Column length. 268 "nullable": True or False, # Whether or not the column can accept a null value. 269 "ordinalPosition": 42, # The ordinal position of the column in the table. 270 "precision": 42, # Column precision. 271 "primaryKey": True or False, # Whether or not the column represents a primary key. 272 "scale": 42, # Column scale. 273 }, 274 ], 275 "tableName": "A String", # Table name. 276 }, 277 ], 278 "schemaName": "A String", # Schema name. 279 }, 280 ], 281 }, 282 "rejectlist": { # Oracle database structure. # Oracle objects to exclude from the stream. 283 "oracleSchemas": [ # Oracle schemas/databases in the database server. 284 { # Oracle schema. 285 "oracleTables": [ # Tables in the schema. 286 { # Oracle table. 287 "oracleColumns": [ # Oracle columns in the schema. When unspecified as part of inclue/exclude lists, includes/excludes everything. 288 { # Oracle Column. 289 "columnName": "A String", # Column name. 290 "dataType": "A String", # The Oracle data type. 291 "encoding": "A String", # Column encoding. 292 "length": 42, # Column length. 293 "nullable": True or False, # Whether or not the column can accept a null value. 294 "ordinalPosition": 42, # The ordinal position of the column in the table. 295 "precision": 42, # Column precision. 296 "primaryKey": True or False, # Whether or not the column represents a primary key. 297 "scale": 42, # Column scale. 298 }, 299 ], 300 "tableName": "A String", # Table name. 301 }, 302 ], 303 "schemaName": "A String", # Schema name. 304 }, 305 ], 306 }, 307 }, 308 "sourceConnectionProfileName": "A String", # Required. Source connection profile identifier. 309 }, 310 "state": "A String", # The state of the stream. 311 "updateTime": "A String", # Output only. The last update time of the stream. 312} 313 314 force: boolean, Optional. Create the stream without validating it. 315 requestId: string, Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). 316 streamId: string, Required. The stream identifier. 317 validateOnly: boolean, Optional. Only validate the stream, but do not create any resources. The default is false. 318 x__xgafv: string, V1 error format. 319 Allowed values 320 1 - v1 error format 321 2 - v2 error format 322 323Returns: 324 An object of the form: 325 326 { # This resource represents a long-running operation that is the result of a network API call. 327 "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. 328 "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. 329 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 330 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. 331 { 332 "a_key": "", # Properties of the object. Contains field @type with type URL. 333 }, 334 ], 335 "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. 336 }, 337 "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. 338 "a_key": "", # Properties of the object. Contains field @type with type URL. 339 }, 340 "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. 341 "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. 342 "a_key": "", # Properties of the object. Contains field @type with type URL. 343 }, 344}</pre> 345</div> 346 347<div class="method"> 348 <code class="details" id="delete">delete(name, requestId=None, x__xgafv=None)</code> 349 <pre>Use this method to delete a stream. 350 351Args: 352 name: string, Required. The name of the stream resource to delete. (required) 353 requestId: string, Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). 354 x__xgafv: string, V1 error format. 355 Allowed values 356 1 - v1 error format 357 2 - v2 error format 358 359Returns: 360 An object of the form: 361 362 { # This resource represents a long-running operation that is the result of a network API call. 363 "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. 364 "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. 365 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 366 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. 367 { 368 "a_key": "", # Properties of the object. Contains field @type with type URL. 369 }, 370 ], 371 "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. 372 }, 373 "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. 374 "a_key": "", # Properties of the object. Contains field @type with type URL. 375 }, 376 "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. 377 "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. 378 "a_key": "", # Properties of the object. Contains field @type with type URL. 379 }, 380}</pre> 381</div> 382 383<div class="method"> 384 <code class="details" id="fetchErrors">fetchErrors(stream, body=None, x__xgafv=None)</code> 385 <pre>Use this method to fetch any errors associated with a stream. 386 387Args: 388 stream: string, Name of the Stream resource for which to fetch any errors. (required) 389 body: object, The request body. 390 The object takes the form of: 391 392{ # Request message for 'FetchErrors' request. 393} 394 395 x__xgafv: string, V1 error format. 396 Allowed values 397 1 - v1 error format 398 2 - v2 error format 399 400Returns: 401 An object of the form: 402 403 { # This resource represents a long-running operation that is the result of a network API call. 404 "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. 405 "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. 406 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 407 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. 408 { 409 "a_key": "", # Properties of the object. Contains field @type with type URL. 410 }, 411 ], 412 "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. 413 }, 414 "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. 415 "a_key": "", # Properties of the object. Contains field @type with type URL. 416 }, 417 "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. 418 "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. 419 "a_key": "", # Properties of the object. Contains field @type with type URL. 420 }, 421}</pre> 422</div> 423 424<div class="method"> 425 <code class="details" id="get">get(name, x__xgafv=None)</code> 426 <pre>Use this method to get details about a stream. 427 428Args: 429 name: string, Required. The name of the stream resource to get. (required) 430 x__xgafv: string, V1 error format. 431 Allowed values 432 1 - v1 error format 433 2 - v2 error format 434 435Returns: 436 An object of the form: 437 438 { 439 "backfillAll": { # Backfill strategy to automatically backfill the Stream's objects. Specific objects can be excluded. # Automatically backfill objects included in the stream source configuration. Specific objects can be excluded. 440 "mysqlExcludedObjects": { # MySQL database structure # MySQL data source objects to avoid backfilling. 441 "mysqlDatabases": [ # Mysql databases on the server 442 { # MySQL database. 443 "databaseName": "A String", # Database name. 444 "mysqlTables": [ # Tables in the database. 445 { # MySQL table. 446 "mysqlColumns": [ # MySQL columns in the database. When unspecified as part of include/exclude lists, includes/excludes everything. 447 { # MySQL Column. 448 "collation": "A String", # Column collation. 449 "columnName": "A String", # Column name. 450 "dataType": "A String", # The MySQL data type. Full data types list can be found here: https://dev.mysql.com/doc/refman/8.0/en/data-types.html 451 "length": 42, # Column length. 452 "nullable": True or False, # Whether or not the column can accept a null value. 453 "ordinalPosition": 42, # The ordinal position of the column in the table. 454 "primaryKey": True or False, # Whether or not the column represents a primary key. 455 }, 456 ], 457 "tableName": "A String", # Table name. 458 }, 459 ], 460 }, 461 ], 462 }, 463 "oracleExcludedObjects": { # Oracle database structure. # Oracle data source objects to avoid backfilling. 464 "oracleSchemas": [ # Oracle schemas/databases in the database server. 465 { # Oracle schema. 466 "oracleTables": [ # Tables in the schema. 467 { # Oracle table. 468 "oracleColumns": [ # Oracle columns in the schema. When unspecified as part of inclue/exclude lists, includes/excludes everything. 469 { # Oracle Column. 470 "columnName": "A String", # Column name. 471 "dataType": "A String", # The Oracle data type. 472 "encoding": "A String", # Column encoding. 473 "length": 42, # Column length. 474 "nullable": True or False, # Whether or not the column can accept a null value. 475 "ordinalPosition": 42, # The ordinal position of the column in the table. 476 "precision": 42, # Column precision. 477 "primaryKey": True or False, # Whether or not the column represents a primary key. 478 "scale": 42, # Column scale. 479 }, 480 ], 481 "tableName": "A String", # Table name. 482 }, 483 ], 484 "schemaName": "A String", # Schema name. 485 }, 486 ], 487 }, 488 }, 489 "backfillNone": { # Backfill strategy to disable automatic backfill for the Stream's objects. # Do not automatically backfill any objects. 490 }, 491 "createTime": "A String", # Output only. The creation time of the stream. 492 "customerManagedEncryptionKey": "A String", # Immutable. A reference to a KMS encryption key. If provided, it will be used to encrypt the data. If left blank, data will be encrypted using an internal Stream-specific encryption key provisioned through KMS. 493 "destinationConfig": { # The configuration of the stream destination. # Required. Destination connection profile configuration. 494 "destinationConnectionProfileName": "A String", # Required. Destination connection profile identifier. 495 "gcsDestinationConfig": { # Google Cloud Storage destination configuration 496 "avroFileFormat": { # AVRO file format configuration. # AVRO file format configuration. 497 }, 498 "fileRotationInterval": "A String", # The maximum duration for which new events are added before a file is closed and a new file is created. 499 "fileRotationMb": 42, # The maximum file size to be saved in the bucket. 500 "gcsFileFormat": "A String", # File format that data should be written in. Deprecated field (b/169501737) - use file_format instead. 501 "jsonFileFormat": { # JSON file format configuration. # JSON file format configuration. 502 "compression": "A String", # Compression of the loaded JSON file. 503 "schemaFileFormat": "A String", # The schema file format along JSON data files. 504 }, 505 "path": "A String", # Path inside the Cloud Storage bucket to write data to. 506 }, 507 }, 508 "displayName": "A String", # Required. Display name. 509 "errors": [ # Output only. Errors on the Stream. 510 { # Represent a user-facing Error. 511 "details": { # Additional information about the error. 512 "a_key": "A String", 513 }, 514 "errorTime": "A String", # The time when the error occurred. 515 "errorUuid": "A String", # A unique identifier for this specific error, allowing it to be traced throughout the system in logs and API responses. 516 "message": "A String", # A message containing more information about the error that occurred. 517 "reason": "A String", # A title that explains the reason for the error. 518 }, 519 ], 520 "labels": { # Labels. 521 "a_key": "A String", 522 }, 523 "name": "A String", # Output only. The stream's name. 524 "sourceConfig": { # The configuration of the stream source. # Required. Source connection profile configuration. 525 "mysqlSourceConfig": { # MySQL source configuration # MySQL data source configuration 526 "allowlist": { # MySQL database structure # MySQL objects to retrieve from the source. 527 "mysqlDatabases": [ # Mysql databases on the server 528 { # MySQL database. 529 "databaseName": "A String", # Database name. 530 "mysqlTables": [ # Tables in the database. 531 { # MySQL table. 532 "mysqlColumns": [ # MySQL columns in the database. When unspecified as part of include/exclude lists, includes/excludes everything. 533 { # MySQL Column. 534 "collation": "A String", # Column collation. 535 "columnName": "A String", # Column name. 536 "dataType": "A String", # The MySQL data type. Full data types list can be found here: https://dev.mysql.com/doc/refman/8.0/en/data-types.html 537 "length": 42, # Column length. 538 "nullable": True or False, # Whether or not the column can accept a null value. 539 "ordinalPosition": 42, # The ordinal position of the column in the table. 540 "primaryKey": True or False, # Whether or not the column represents a primary key. 541 }, 542 ], 543 "tableName": "A String", # Table name. 544 }, 545 ], 546 }, 547 ], 548 }, 549 "rejectlist": { # MySQL database structure # MySQL objects to exclude from the stream. 550 "mysqlDatabases": [ # Mysql databases on the server 551 { # MySQL database. 552 "databaseName": "A String", # Database name. 553 "mysqlTables": [ # Tables in the database. 554 { # MySQL table. 555 "mysqlColumns": [ # MySQL columns in the database. When unspecified as part of include/exclude lists, includes/excludes everything. 556 { # MySQL Column. 557 "collation": "A String", # Column collation. 558 "columnName": "A String", # Column name. 559 "dataType": "A String", # The MySQL data type. Full data types list can be found here: https://dev.mysql.com/doc/refman/8.0/en/data-types.html 560 "length": 42, # Column length. 561 "nullable": True or False, # Whether or not the column can accept a null value. 562 "ordinalPosition": 42, # The ordinal position of the column in the table. 563 "primaryKey": True or False, # Whether or not the column represents a primary key. 564 }, 565 ], 566 "tableName": "A String", # Table name. 567 }, 568 ], 569 }, 570 ], 571 }, 572 }, 573 "oracleSourceConfig": { # Oracle data source configuration # Oracle data source configuration 574 "allowlist": { # Oracle database structure. # Oracle objects to include in the stream. 575 "oracleSchemas": [ # Oracle schemas/databases in the database server. 576 { # Oracle schema. 577 "oracleTables": [ # Tables in the schema. 578 { # Oracle table. 579 "oracleColumns": [ # Oracle columns in the schema. When unspecified as part of inclue/exclude lists, includes/excludes everything. 580 { # Oracle Column. 581 "columnName": "A String", # Column name. 582 "dataType": "A String", # The Oracle data type. 583 "encoding": "A String", # Column encoding. 584 "length": 42, # Column length. 585 "nullable": True or False, # Whether or not the column can accept a null value. 586 "ordinalPosition": 42, # The ordinal position of the column in the table. 587 "precision": 42, # Column precision. 588 "primaryKey": True or False, # Whether or not the column represents a primary key. 589 "scale": 42, # Column scale. 590 }, 591 ], 592 "tableName": "A String", # Table name. 593 }, 594 ], 595 "schemaName": "A String", # Schema name. 596 }, 597 ], 598 }, 599 "rejectlist": { # Oracle database structure. # Oracle objects to exclude from the stream. 600 "oracleSchemas": [ # Oracle schemas/databases in the database server. 601 { # Oracle schema. 602 "oracleTables": [ # Tables in the schema. 603 { # Oracle table. 604 "oracleColumns": [ # Oracle columns in the schema. When unspecified as part of inclue/exclude lists, includes/excludes everything. 605 { # Oracle Column. 606 "columnName": "A String", # Column name. 607 "dataType": "A String", # The Oracle data type. 608 "encoding": "A String", # Column encoding. 609 "length": 42, # Column length. 610 "nullable": True or False, # Whether or not the column can accept a null value. 611 "ordinalPosition": 42, # The ordinal position of the column in the table. 612 "precision": 42, # Column precision. 613 "primaryKey": True or False, # Whether or not the column represents a primary key. 614 "scale": 42, # Column scale. 615 }, 616 ], 617 "tableName": "A String", # Table name. 618 }, 619 ], 620 "schemaName": "A String", # Schema name. 621 }, 622 ], 623 }, 624 }, 625 "sourceConnectionProfileName": "A String", # Required. Source connection profile identifier. 626 }, 627 "state": "A String", # The state of the stream. 628 "updateTime": "A String", # Output only. The last update time of the stream. 629}</pre> 630</div> 631 632<div class="method"> 633 <code class="details" id="list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</code> 634 <pre>Use this method to list streams in a project and location. 635 636Args: 637 parent: string, Required. The parent that owns the collection of streams. (required) 638 filter: string, Filter request. 639 orderBy: string, Order by fields for the result. 640 pageSize: integer, Maximum number of streams to return. If unspecified, at most 50 streams will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. 641 pageToken: string, Page token received from a previous `ListStreams` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListStreams` must match the call that provided the page token. 642 x__xgafv: string, V1 error format. 643 Allowed values 644 1 - v1 error format 645 2 - v2 error format 646 647Returns: 648 An object of the form: 649 650 { 651 "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. 652 "streams": [ # List of streams 653 { 654 "backfillAll": { # Backfill strategy to automatically backfill the Stream's objects. Specific objects can be excluded. # Automatically backfill objects included in the stream source configuration. Specific objects can be excluded. 655 "mysqlExcludedObjects": { # MySQL database structure # MySQL data source objects to avoid backfilling. 656 "mysqlDatabases": [ # Mysql databases on the server 657 { # MySQL database. 658 "databaseName": "A String", # Database name. 659 "mysqlTables": [ # Tables in the database. 660 { # MySQL table. 661 "mysqlColumns": [ # MySQL columns in the database. When unspecified as part of include/exclude lists, includes/excludes everything. 662 { # MySQL Column. 663 "collation": "A String", # Column collation. 664 "columnName": "A String", # Column name. 665 "dataType": "A String", # The MySQL data type. Full data types list can be found here: https://dev.mysql.com/doc/refman/8.0/en/data-types.html 666 "length": 42, # Column length. 667 "nullable": True or False, # Whether or not the column can accept a null value. 668 "ordinalPosition": 42, # The ordinal position of the column in the table. 669 "primaryKey": True or False, # Whether or not the column represents a primary key. 670 }, 671 ], 672 "tableName": "A String", # Table name. 673 }, 674 ], 675 }, 676 ], 677 }, 678 "oracleExcludedObjects": { # Oracle database structure. # Oracle data source objects to avoid backfilling. 679 "oracleSchemas": [ # Oracle schemas/databases in the database server. 680 { # Oracle schema. 681 "oracleTables": [ # Tables in the schema. 682 { # Oracle table. 683 "oracleColumns": [ # Oracle columns in the schema. When unspecified as part of inclue/exclude lists, includes/excludes everything. 684 { # Oracle Column. 685 "columnName": "A String", # Column name. 686 "dataType": "A String", # The Oracle data type. 687 "encoding": "A String", # Column encoding. 688 "length": 42, # Column length. 689 "nullable": True or False, # Whether or not the column can accept a null value. 690 "ordinalPosition": 42, # The ordinal position of the column in the table. 691 "precision": 42, # Column precision. 692 "primaryKey": True or False, # Whether or not the column represents a primary key. 693 "scale": 42, # Column scale. 694 }, 695 ], 696 "tableName": "A String", # Table name. 697 }, 698 ], 699 "schemaName": "A String", # Schema name. 700 }, 701 ], 702 }, 703 }, 704 "backfillNone": { # Backfill strategy to disable automatic backfill for the Stream's objects. # Do not automatically backfill any objects. 705 }, 706 "createTime": "A String", # Output only. The creation time of the stream. 707 "customerManagedEncryptionKey": "A String", # Immutable. A reference to a KMS encryption key. If provided, it will be used to encrypt the data. If left blank, data will be encrypted using an internal Stream-specific encryption key provisioned through KMS. 708 "destinationConfig": { # The configuration of the stream destination. # Required. Destination connection profile configuration. 709 "destinationConnectionProfileName": "A String", # Required. Destination connection profile identifier. 710 "gcsDestinationConfig": { # Google Cloud Storage destination configuration 711 "avroFileFormat": { # AVRO file format configuration. # AVRO file format configuration. 712 }, 713 "fileRotationInterval": "A String", # The maximum duration for which new events are added before a file is closed and a new file is created. 714 "fileRotationMb": 42, # The maximum file size to be saved in the bucket. 715 "gcsFileFormat": "A String", # File format that data should be written in. Deprecated field (b/169501737) - use file_format instead. 716 "jsonFileFormat": { # JSON file format configuration. # JSON file format configuration. 717 "compression": "A String", # Compression of the loaded JSON file. 718 "schemaFileFormat": "A String", # The schema file format along JSON data files. 719 }, 720 "path": "A String", # Path inside the Cloud Storage bucket to write data to. 721 }, 722 }, 723 "displayName": "A String", # Required. Display name. 724 "errors": [ # Output only. Errors on the Stream. 725 { # Represent a user-facing Error. 726 "details": { # Additional information about the error. 727 "a_key": "A String", 728 }, 729 "errorTime": "A String", # The time when the error occurred. 730 "errorUuid": "A String", # A unique identifier for this specific error, allowing it to be traced throughout the system in logs and API responses. 731 "message": "A String", # A message containing more information about the error that occurred. 732 "reason": "A String", # A title that explains the reason for the error. 733 }, 734 ], 735 "labels": { # Labels. 736 "a_key": "A String", 737 }, 738 "name": "A String", # Output only. The stream's name. 739 "sourceConfig": { # The configuration of the stream source. # Required. Source connection profile configuration. 740 "mysqlSourceConfig": { # MySQL source configuration # MySQL data source configuration 741 "allowlist": { # MySQL database structure # MySQL objects to retrieve from the source. 742 "mysqlDatabases": [ # Mysql databases on the server 743 { # MySQL database. 744 "databaseName": "A String", # Database name. 745 "mysqlTables": [ # Tables in the database. 746 { # MySQL table. 747 "mysqlColumns": [ # MySQL columns in the database. When unspecified as part of include/exclude lists, includes/excludes everything. 748 { # MySQL Column. 749 "collation": "A String", # Column collation. 750 "columnName": "A String", # Column name. 751 "dataType": "A String", # The MySQL data type. Full data types list can be found here: https://dev.mysql.com/doc/refman/8.0/en/data-types.html 752 "length": 42, # Column length. 753 "nullable": True or False, # Whether or not the column can accept a null value. 754 "ordinalPosition": 42, # The ordinal position of the column in the table. 755 "primaryKey": True or False, # Whether or not the column represents a primary key. 756 }, 757 ], 758 "tableName": "A String", # Table name. 759 }, 760 ], 761 }, 762 ], 763 }, 764 "rejectlist": { # MySQL database structure # MySQL objects to exclude from the stream. 765 "mysqlDatabases": [ # Mysql databases on the server 766 { # MySQL database. 767 "databaseName": "A String", # Database name. 768 "mysqlTables": [ # Tables in the database. 769 { # MySQL table. 770 "mysqlColumns": [ # MySQL columns in the database. When unspecified as part of include/exclude lists, includes/excludes everything. 771 { # MySQL Column. 772 "collation": "A String", # Column collation. 773 "columnName": "A String", # Column name. 774 "dataType": "A String", # The MySQL data type. Full data types list can be found here: https://dev.mysql.com/doc/refman/8.0/en/data-types.html 775 "length": 42, # Column length. 776 "nullable": True or False, # Whether or not the column can accept a null value. 777 "ordinalPosition": 42, # The ordinal position of the column in the table. 778 "primaryKey": True or False, # Whether or not the column represents a primary key. 779 }, 780 ], 781 "tableName": "A String", # Table name. 782 }, 783 ], 784 }, 785 ], 786 }, 787 }, 788 "oracleSourceConfig": { # Oracle data source configuration # Oracle data source configuration 789 "allowlist": { # Oracle database structure. # Oracle objects to include in the stream. 790 "oracleSchemas": [ # Oracle schemas/databases in the database server. 791 { # Oracle schema. 792 "oracleTables": [ # Tables in the schema. 793 { # Oracle table. 794 "oracleColumns": [ # Oracle columns in the schema. When unspecified as part of inclue/exclude lists, includes/excludes everything. 795 { # Oracle Column. 796 "columnName": "A String", # Column name. 797 "dataType": "A String", # The Oracle data type. 798 "encoding": "A String", # Column encoding. 799 "length": 42, # Column length. 800 "nullable": True or False, # Whether or not the column can accept a null value. 801 "ordinalPosition": 42, # The ordinal position of the column in the table. 802 "precision": 42, # Column precision. 803 "primaryKey": True or False, # Whether or not the column represents a primary key. 804 "scale": 42, # Column scale. 805 }, 806 ], 807 "tableName": "A String", # Table name. 808 }, 809 ], 810 "schemaName": "A String", # Schema name. 811 }, 812 ], 813 }, 814 "rejectlist": { # Oracle database structure. # Oracle objects to exclude from the stream. 815 "oracleSchemas": [ # Oracle schemas/databases in the database server. 816 { # Oracle schema. 817 "oracleTables": [ # Tables in the schema. 818 { # Oracle table. 819 "oracleColumns": [ # Oracle columns in the schema. When unspecified as part of inclue/exclude lists, includes/excludes everything. 820 { # Oracle Column. 821 "columnName": "A String", # Column name. 822 "dataType": "A String", # The Oracle data type. 823 "encoding": "A String", # Column encoding. 824 "length": 42, # Column length. 825 "nullable": True or False, # Whether or not the column can accept a null value. 826 "ordinalPosition": 42, # The ordinal position of the column in the table. 827 "precision": 42, # Column precision. 828 "primaryKey": True or False, # Whether or not the column represents a primary key. 829 "scale": 42, # Column scale. 830 }, 831 ], 832 "tableName": "A String", # Table name. 833 }, 834 ], 835 "schemaName": "A String", # Schema name. 836 }, 837 ], 838 }, 839 }, 840 "sourceConnectionProfileName": "A String", # Required. Source connection profile identifier. 841 }, 842 "state": "A String", # The state of the stream. 843 "updateTime": "A String", # Output only. The last update time of the stream. 844 }, 845 ], 846 "unreachable": [ # Locations that could not be reached. 847 "A String", 848 ], 849}</pre> 850</div> 851 852<div class="method"> 853 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 854 <pre>Retrieves the next page of results. 855 856Args: 857 previous_request: The request for the previous page. (required) 858 previous_response: The response from the request for the previous page. (required) 859 860Returns: 861 A request object that you can call 'execute()' on to request the next 862 page. Returns None if there are no more items in the collection. 863 </pre> 864</div> 865 866<div class="method"> 867 <code class="details" id="patch">patch(name, body=None, force=None, requestId=None, updateMask=None, validateOnly=None, x__xgafv=None)</code> 868 <pre>Use this method to update the configuration of a stream. 869 870Args: 871 name: string, Output only. The stream's name. (required) 872 body: object, The request body. 873 The object takes the form of: 874 875{ 876 "backfillAll": { # Backfill strategy to automatically backfill the Stream's objects. Specific objects can be excluded. # Automatically backfill objects included in the stream source configuration. Specific objects can be excluded. 877 "mysqlExcludedObjects": { # MySQL database structure # MySQL data source objects to avoid backfilling. 878 "mysqlDatabases": [ # Mysql databases on the server 879 { # MySQL database. 880 "databaseName": "A String", # Database name. 881 "mysqlTables": [ # Tables in the database. 882 { # MySQL table. 883 "mysqlColumns": [ # MySQL columns in the database. When unspecified as part of include/exclude lists, includes/excludes everything. 884 { # MySQL Column. 885 "collation": "A String", # Column collation. 886 "columnName": "A String", # Column name. 887 "dataType": "A String", # The MySQL data type. Full data types list can be found here: https://dev.mysql.com/doc/refman/8.0/en/data-types.html 888 "length": 42, # Column length. 889 "nullable": True or False, # Whether or not the column can accept a null value. 890 "ordinalPosition": 42, # The ordinal position of the column in the table. 891 "primaryKey": True or False, # Whether or not the column represents a primary key. 892 }, 893 ], 894 "tableName": "A String", # Table name. 895 }, 896 ], 897 }, 898 ], 899 }, 900 "oracleExcludedObjects": { # Oracle database structure. # Oracle data source objects to avoid backfilling. 901 "oracleSchemas": [ # Oracle schemas/databases in the database server. 902 { # Oracle schema. 903 "oracleTables": [ # Tables in the schema. 904 { # Oracle table. 905 "oracleColumns": [ # Oracle columns in the schema. When unspecified as part of inclue/exclude lists, includes/excludes everything. 906 { # Oracle Column. 907 "columnName": "A String", # Column name. 908 "dataType": "A String", # The Oracle data type. 909 "encoding": "A String", # Column encoding. 910 "length": 42, # Column length. 911 "nullable": True or False, # Whether or not the column can accept a null value. 912 "ordinalPosition": 42, # The ordinal position of the column in the table. 913 "precision": 42, # Column precision. 914 "primaryKey": True or False, # Whether or not the column represents a primary key. 915 "scale": 42, # Column scale. 916 }, 917 ], 918 "tableName": "A String", # Table name. 919 }, 920 ], 921 "schemaName": "A String", # Schema name. 922 }, 923 ], 924 }, 925 }, 926 "backfillNone": { # Backfill strategy to disable automatic backfill for the Stream's objects. # Do not automatically backfill any objects. 927 }, 928 "createTime": "A String", # Output only. The creation time of the stream. 929 "customerManagedEncryptionKey": "A String", # Immutable. A reference to a KMS encryption key. If provided, it will be used to encrypt the data. If left blank, data will be encrypted using an internal Stream-specific encryption key provisioned through KMS. 930 "destinationConfig": { # The configuration of the stream destination. # Required. Destination connection profile configuration. 931 "destinationConnectionProfileName": "A String", # Required. Destination connection profile identifier. 932 "gcsDestinationConfig": { # Google Cloud Storage destination configuration 933 "avroFileFormat": { # AVRO file format configuration. # AVRO file format configuration. 934 }, 935 "fileRotationInterval": "A String", # The maximum duration for which new events are added before a file is closed and a new file is created. 936 "fileRotationMb": 42, # The maximum file size to be saved in the bucket. 937 "gcsFileFormat": "A String", # File format that data should be written in. Deprecated field (b/169501737) - use file_format instead. 938 "jsonFileFormat": { # JSON file format configuration. # JSON file format configuration. 939 "compression": "A String", # Compression of the loaded JSON file. 940 "schemaFileFormat": "A String", # The schema file format along JSON data files. 941 }, 942 "path": "A String", # Path inside the Cloud Storage bucket to write data to. 943 }, 944 }, 945 "displayName": "A String", # Required. Display name. 946 "errors": [ # Output only. Errors on the Stream. 947 { # Represent a user-facing Error. 948 "details": { # Additional information about the error. 949 "a_key": "A String", 950 }, 951 "errorTime": "A String", # The time when the error occurred. 952 "errorUuid": "A String", # A unique identifier for this specific error, allowing it to be traced throughout the system in logs and API responses. 953 "message": "A String", # A message containing more information about the error that occurred. 954 "reason": "A String", # A title that explains the reason for the error. 955 }, 956 ], 957 "labels": { # Labels. 958 "a_key": "A String", 959 }, 960 "name": "A String", # Output only. The stream's name. 961 "sourceConfig": { # The configuration of the stream source. # Required. Source connection profile configuration. 962 "mysqlSourceConfig": { # MySQL source configuration # MySQL data source configuration 963 "allowlist": { # MySQL database structure # MySQL objects to retrieve from the source. 964 "mysqlDatabases": [ # Mysql databases on the server 965 { # MySQL database. 966 "databaseName": "A String", # Database name. 967 "mysqlTables": [ # Tables in the database. 968 { # MySQL table. 969 "mysqlColumns": [ # MySQL columns in the database. When unspecified as part of include/exclude lists, includes/excludes everything. 970 { # MySQL Column. 971 "collation": "A String", # Column collation. 972 "columnName": "A String", # Column name. 973 "dataType": "A String", # The MySQL data type. Full data types list can be found here: https://dev.mysql.com/doc/refman/8.0/en/data-types.html 974 "length": 42, # Column length. 975 "nullable": True or False, # Whether or not the column can accept a null value. 976 "ordinalPosition": 42, # The ordinal position of the column in the table. 977 "primaryKey": True or False, # Whether or not the column represents a primary key. 978 }, 979 ], 980 "tableName": "A String", # Table name. 981 }, 982 ], 983 }, 984 ], 985 }, 986 "rejectlist": { # MySQL database structure # MySQL objects to exclude from the stream. 987 "mysqlDatabases": [ # Mysql databases on the server 988 { # MySQL database. 989 "databaseName": "A String", # Database name. 990 "mysqlTables": [ # Tables in the database. 991 { # MySQL table. 992 "mysqlColumns": [ # MySQL columns in the database. When unspecified as part of include/exclude lists, includes/excludes everything. 993 { # MySQL Column. 994 "collation": "A String", # Column collation. 995 "columnName": "A String", # Column name. 996 "dataType": "A String", # The MySQL data type. Full data types list can be found here: https://dev.mysql.com/doc/refman/8.0/en/data-types.html 997 "length": 42, # Column length. 998 "nullable": True or False, # Whether or not the column can accept a null value. 999 "ordinalPosition": 42, # The ordinal position of the column in the table. 1000 "primaryKey": True or False, # Whether or not the column represents a primary key. 1001 }, 1002 ], 1003 "tableName": "A String", # Table name. 1004 }, 1005 ], 1006 }, 1007 ], 1008 }, 1009 }, 1010 "oracleSourceConfig": { # Oracle data source configuration # Oracle data source configuration 1011 "allowlist": { # Oracle database structure. # Oracle objects to include in the stream. 1012 "oracleSchemas": [ # Oracle schemas/databases in the database server. 1013 { # Oracle schema. 1014 "oracleTables": [ # Tables in the schema. 1015 { # Oracle table. 1016 "oracleColumns": [ # Oracle columns in the schema. When unspecified as part of inclue/exclude lists, includes/excludes everything. 1017 { # Oracle Column. 1018 "columnName": "A String", # Column name. 1019 "dataType": "A String", # The Oracle data type. 1020 "encoding": "A String", # Column encoding. 1021 "length": 42, # Column length. 1022 "nullable": True or False, # Whether or not the column can accept a null value. 1023 "ordinalPosition": 42, # The ordinal position of the column in the table. 1024 "precision": 42, # Column precision. 1025 "primaryKey": True or False, # Whether or not the column represents a primary key. 1026 "scale": 42, # Column scale. 1027 }, 1028 ], 1029 "tableName": "A String", # Table name. 1030 }, 1031 ], 1032 "schemaName": "A String", # Schema name. 1033 }, 1034 ], 1035 }, 1036 "rejectlist": { # Oracle database structure. # Oracle objects to exclude from the stream. 1037 "oracleSchemas": [ # Oracle schemas/databases in the database server. 1038 { # Oracle schema. 1039 "oracleTables": [ # Tables in the schema. 1040 { # Oracle table. 1041 "oracleColumns": [ # Oracle columns in the schema. When unspecified as part of inclue/exclude lists, includes/excludes everything. 1042 { # Oracle Column. 1043 "columnName": "A String", # Column name. 1044 "dataType": "A String", # The Oracle data type. 1045 "encoding": "A String", # Column encoding. 1046 "length": 42, # Column length. 1047 "nullable": True or False, # Whether or not the column can accept a null value. 1048 "ordinalPosition": 42, # The ordinal position of the column in the table. 1049 "precision": 42, # Column precision. 1050 "primaryKey": True or False, # Whether or not the column represents a primary key. 1051 "scale": 42, # Column scale. 1052 }, 1053 ], 1054 "tableName": "A String", # Table name. 1055 }, 1056 ], 1057 "schemaName": "A String", # Schema name. 1058 }, 1059 ], 1060 }, 1061 }, 1062 "sourceConnectionProfileName": "A String", # Required. Source connection profile identifier. 1063 }, 1064 "state": "A String", # The state of the stream. 1065 "updateTime": "A String", # Output only. The last update time of the stream. 1066} 1067 1068 force: boolean, Optional. Execute the update without validating it. 1069 requestId: string, Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). 1070 updateMask: string, Optional. Field mask is used to specify the fields to be overwritten in the stream resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. 1071 validateOnly: boolean, Optional. Only validate the stream with the changes, without actually updating it. The default is false. 1072 x__xgafv: string, V1 error format. 1073 Allowed values 1074 1 - v1 error format 1075 2 - v2 error format 1076 1077Returns: 1078 An object of the form: 1079 1080 { # This resource represents a long-running operation that is the result of a network API call. 1081 "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. 1082 "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. 1083 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 1084 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. 1085 { 1086 "a_key": "", # Properties of the object. Contains field @type with type URL. 1087 }, 1088 ], 1089 "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. 1090 }, 1091 "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. 1092 "a_key": "", # Properties of the object. Contains field @type with type URL. 1093 }, 1094 "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. 1095 "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. 1096 "a_key": "", # Properties of the object. Contains field @type with type URL. 1097 }, 1098}</pre> 1099</div> 1100 1101</body></html>