Returns the objects Resource.
Close httplib2 connections.
Use this method to create a stream.
delete(name, requestId=None, x__xgafv=None)
Use this method to delete a stream.
fetchErrors(stream, body=None, x__xgafv=None)
Use this method to fetch any errors associated with a stream.
Use this method to get details about a stream.
list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
Use this method to list streams in a project and location.
list_next(previous_request, previous_response)
Retrieves the next page of results.
Use this method to update the configuration of a stream.
close()
Close httplib2 connections.
create(parent, body=None, force=None, requestId=None, streamId=None, validateOnly=None, x__xgafv=None)
Use this method to create a stream.
Args:
parent: string, Required. The parent that owns the collection of streams. (required)
body: object, The request body.
The object takes the form of:
{
"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.
"mysqlExcludedObjects": { # MySQL database structure # MySQL data source objects to avoid backfilling.
"mysqlDatabases": [ # Mysql databases on the server
{ # MySQL database.
"databaseName": "A String", # Database name.
"mysqlTables": [ # Tables in the database.
{ # MySQL table.
"mysqlColumns": [ # MySQL columns in the database. When unspecified as part of include/exclude lists, includes/excludes everything.
{ # MySQL Column.
"collation": "A String", # Column collation.
"columnName": "A String", # Column name.
"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
"length": 42, # Column length.
"nullable": True or False, # Whether or not the column can accept a null value.
"ordinalPosition": 42, # The ordinal position of the column in the table.
"primaryKey": True or False, # Whether or not the column represents a primary key.
},
],
"tableName": "A String", # Table name.
},
],
},
],
},
"oracleExcludedObjects": { # Oracle database structure. # Oracle data source objects to avoid backfilling.
"oracleSchemas": [ # Oracle schemas/databases in the database server.
{ # Oracle schema.
"oracleTables": [ # Tables in the schema.
{ # Oracle table.
"oracleColumns": [ # Oracle columns in the schema. When unspecified as part of inclue/exclude lists, includes/excludes everything.
{ # Oracle Column.
"columnName": "A String", # Column name.
"dataType": "A String", # The Oracle data type.
"encoding": "A String", # Column encoding.
"length": 42, # Column length.
"nullable": True or False, # Whether or not the column can accept a null value.
"ordinalPosition": 42, # The ordinal position of the column in the table.
"precision": 42, # Column precision.
"primaryKey": True or False, # Whether or not the column represents a primary key.
"scale": 42, # Column scale.
},
],
"tableName": "A String", # Table name.
},
],
"schemaName": "A String", # Schema name.
},
],
},
},
"backfillNone": { # Backfill strategy to disable automatic backfill for the Stream's objects. # Do not automatically backfill any objects.
},
"createTime": "A String", # Output only. The creation time of the stream.
"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.
"destinationConfig": { # The configuration of the stream destination. # Required. Destination connection profile configuration.
"destinationConnectionProfileName": "A String", # Required. Destination connection profile identifier.
"gcsDestinationConfig": { # Google Cloud Storage destination configuration
"avroFileFormat": { # AVRO file format configuration. # AVRO file format configuration.
},
"fileRotationInterval": "A String", # The maximum duration for which new events are added before a file is closed and a new file is created.
"fileRotationMb": 42, # The maximum file size to be saved in the bucket.
"gcsFileFormat": "A String", # File format that data should be written in. Deprecated field (b/169501737) - use file_format instead.
"jsonFileFormat": { # JSON file format configuration. # JSON file format configuration.
"compression": "A String", # Compression of the loaded JSON file.
"schemaFileFormat": "A String", # The schema file format along JSON data files.
},
"path": "A String", # Path inside the Cloud Storage bucket to write data to.
},
},
"displayName": "A String", # Required. Display name.
"errors": [ # Output only. Errors on the Stream.
{ # Represent a user-facing Error.
"details": { # Additional information about the error.
"a_key": "A String",
},
"errorTime": "A String", # The time when the error occurred.
"errorUuid": "A String", # A unique identifier for this specific error, allowing it to be traced throughout the system in logs and API responses.
"message": "A String", # A message containing more information about the error that occurred.
"reason": "A String", # A title that explains the reason for the error.
},
],
"labels": { # Labels.
"a_key": "A String",
},
"name": "A String", # Output only. The stream's name.
"sourceConfig": { # The configuration of the stream source. # Required. Source connection profile configuration.
"mysqlSourceConfig": { # MySQL source configuration # MySQL data source configuration
"allowlist": { # MySQL database structure # MySQL objects to retrieve from the source.
"mysqlDatabases": [ # Mysql databases on the server
{ # MySQL database.
"databaseName": "A String", # Database name.
"mysqlTables": [ # Tables in the database.
{ # MySQL table.
"mysqlColumns": [ # MySQL columns in the database. When unspecified as part of include/exclude lists, includes/excludes everything.
{ # MySQL Column.
"collation": "A String", # Column collation.
"columnName": "A String", # Column name.
"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
"length": 42, # Column length.
"nullable": True or False, # Whether or not the column can accept a null value.
"ordinalPosition": 42, # The ordinal position of the column in the table.
"primaryKey": True or False, # Whether or not the column represents a primary key.
},
],
"tableName": "A String", # Table name.
},
],
},
],
},
"rejectlist": { # MySQL database structure # MySQL objects to exclude from the stream.
"mysqlDatabases": [ # Mysql databases on the server
{ # MySQL database.
"databaseName": "A String", # Database name.
"mysqlTables": [ # Tables in the database.
{ # MySQL table.
"mysqlColumns": [ # MySQL columns in the database. When unspecified as part of include/exclude lists, includes/excludes everything.
{ # MySQL Column.
"collation": "A String", # Column collation.
"columnName": "A String", # Column name.
"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
"length": 42, # Column length.
"nullable": True or False, # Whether or not the column can accept a null value.
"ordinalPosition": 42, # The ordinal position of the column in the table.
"primaryKey": True or False, # Whether or not the column represents a primary key.
},
],
"tableName": "A String", # Table name.
},
],
},
],
},
},
"oracleSourceConfig": { # Oracle data source configuration # Oracle data source configuration
"allowlist": { # Oracle database structure. # Oracle objects to include in the stream.
"oracleSchemas": [ # Oracle schemas/databases in the database server.
{ # Oracle schema.
"oracleTables": [ # Tables in the schema.
{ # Oracle table.
"oracleColumns": [ # Oracle columns in the schema. When unspecified as part of inclue/exclude lists, includes/excludes everything.
{ # Oracle Column.
"columnName": "A String", # Column name.
"dataType": "A String", # The Oracle data type.
"encoding": "A String", # Column encoding.
"length": 42, # Column length.
"nullable": True or False, # Whether or not the column can accept a null value.
"ordinalPosition": 42, # The ordinal position of the column in the table.
"precision": 42, # Column precision.
"primaryKey": True or False, # Whether or not the column represents a primary key.
"scale": 42, # Column scale.
},
],
"tableName": "A String", # Table name.
},
],
"schemaName": "A String", # Schema name.
},
],
},
"rejectlist": { # Oracle database structure. # Oracle objects to exclude from the stream.
"oracleSchemas": [ # Oracle schemas/databases in the database server.
{ # Oracle schema.
"oracleTables": [ # Tables in the schema.
{ # Oracle table.
"oracleColumns": [ # Oracle columns in the schema. When unspecified as part of inclue/exclude lists, includes/excludes everything.
{ # Oracle Column.
"columnName": "A String", # Column name.
"dataType": "A String", # The Oracle data type.
"encoding": "A String", # Column encoding.
"length": 42, # Column length.
"nullable": True or False, # Whether or not the column can accept a null value.
"ordinalPosition": 42, # The ordinal position of the column in the table.
"precision": 42, # Column precision.
"primaryKey": True or False, # Whether or not the column represents a primary key.
"scale": 42, # Column scale.
},
],
"tableName": "A String", # Table name.
},
],
"schemaName": "A String", # Schema name.
},
],
},
},
"sourceConnectionProfileName": "A String", # Required. Source connection profile identifier.
},
"state": "A String", # The state of the stream.
"updateTime": "A String", # Output only. The last update time of the stream.
}
force: boolean, Optional. Create the stream without validating it.
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).
streamId: string, Required. The stream identifier.
validateOnly: boolean, Optional. Only validate the stream, but do not create any resources. The default is false.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"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.
"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.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"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.
},
"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.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"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}`.
"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`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}
delete(name, requestId=None, x__xgafv=None)
Use this method to delete a stream.
Args:
name: string, Required. The name of the stream resource to delete. (required)
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).
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"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.
"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.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"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.
},
"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.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"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}`.
"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`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}
fetchErrors(stream, body=None, x__xgafv=None)
Use this method to fetch any errors associated with a stream.
Args:
stream: string, Name of the Stream resource for which to fetch any errors. (required)
body: object, The request body.
The object takes the form of:
{ # Request message for 'FetchErrors' request.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"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.
"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.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"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.
},
"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.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"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}`.
"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`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}
get(name, x__xgafv=None)
Use this method to get details about a stream.
Args:
name: string, Required. The name of the stream resource to get. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"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.
"mysqlExcludedObjects": { # MySQL database structure # MySQL data source objects to avoid backfilling.
"mysqlDatabases": [ # Mysql databases on the server
{ # MySQL database.
"databaseName": "A String", # Database name.
"mysqlTables": [ # Tables in the database.
{ # MySQL table.
"mysqlColumns": [ # MySQL columns in the database. When unspecified as part of include/exclude lists, includes/excludes everything.
{ # MySQL Column.
"collation": "A String", # Column collation.
"columnName": "A String", # Column name.
"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
"length": 42, # Column length.
"nullable": True or False, # Whether or not the column can accept a null value.
"ordinalPosition": 42, # The ordinal position of the column in the table.
"primaryKey": True or False, # Whether or not the column represents a primary key.
},
],
"tableName": "A String", # Table name.
},
],
},
],
},
"oracleExcludedObjects": { # Oracle database structure. # Oracle data source objects to avoid backfilling.
"oracleSchemas": [ # Oracle schemas/databases in the database server.
{ # Oracle schema.
"oracleTables": [ # Tables in the schema.
{ # Oracle table.
"oracleColumns": [ # Oracle columns in the schema. When unspecified as part of inclue/exclude lists, includes/excludes everything.
{ # Oracle Column.
"columnName": "A String", # Column name.
"dataType": "A String", # The Oracle data type.
"encoding": "A String", # Column encoding.
"length": 42, # Column length.
"nullable": True or False, # Whether or not the column can accept a null value.
"ordinalPosition": 42, # The ordinal position of the column in the table.
"precision": 42, # Column precision.
"primaryKey": True or False, # Whether or not the column represents a primary key.
"scale": 42, # Column scale.
},
],
"tableName": "A String", # Table name.
},
],
"schemaName": "A String", # Schema name.
},
],
},
},
"backfillNone": { # Backfill strategy to disable automatic backfill for the Stream's objects. # Do not automatically backfill any objects.
},
"createTime": "A String", # Output only. The creation time of the stream.
"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.
"destinationConfig": { # The configuration of the stream destination. # Required. Destination connection profile configuration.
"destinationConnectionProfileName": "A String", # Required. Destination connection profile identifier.
"gcsDestinationConfig": { # Google Cloud Storage destination configuration
"avroFileFormat": { # AVRO file format configuration. # AVRO file format configuration.
},
"fileRotationInterval": "A String", # The maximum duration for which new events are added before a file is closed and a new file is created.
"fileRotationMb": 42, # The maximum file size to be saved in the bucket.
"gcsFileFormat": "A String", # File format that data should be written in. Deprecated field (b/169501737) - use file_format instead.
"jsonFileFormat": { # JSON file format configuration. # JSON file format configuration.
"compression": "A String", # Compression of the loaded JSON file.
"schemaFileFormat": "A String", # The schema file format along JSON data files.
},
"path": "A String", # Path inside the Cloud Storage bucket to write data to.
},
},
"displayName": "A String", # Required. Display name.
"errors": [ # Output only. Errors on the Stream.
{ # Represent a user-facing Error.
"details": { # Additional information about the error.
"a_key": "A String",
},
"errorTime": "A String", # The time when the error occurred.
"errorUuid": "A String", # A unique identifier for this specific error, allowing it to be traced throughout the system in logs and API responses.
"message": "A String", # A message containing more information about the error that occurred.
"reason": "A String", # A title that explains the reason for the error.
},
],
"labels": { # Labels.
"a_key": "A String",
},
"name": "A String", # Output only. The stream's name.
"sourceConfig": { # The configuration of the stream source. # Required. Source connection profile configuration.
"mysqlSourceConfig": { # MySQL source configuration # MySQL data source configuration
"allowlist": { # MySQL database structure # MySQL objects to retrieve from the source.
"mysqlDatabases": [ # Mysql databases on the server
{ # MySQL database.
"databaseName": "A String", # Database name.
"mysqlTables": [ # Tables in the database.
{ # MySQL table.
"mysqlColumns": [ # MySQL columns in the database. When unspecified as part of include/exclude lists, includes/excludes everything.
{ # MySQL Column.
"collation": "A String", # Column collation.
"columnName": "A String", # Column name.
"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
"length": 42, # Column length.
"nullable": True or False, # Whether or not the column can accept a null value.
"ordinalPosition": 42, # The ordinal position of the column in the table.
"primaryKey": True or False, # Whether or not the column represents a primary key.
},
],
"tableName": "A String", # Table name.
},
],
},
],
},
"rejectlist": { # MySQL database structure # MySQL objects to exclude from the stream.
"mysqlDatabases": [ # Mysql databases on the server
{ # MySQL database.
"databaseName": "A String", # Database name.
"mysqlTables": [ # Tables in the database.
{ # MySQL table.
"mysqlColumns": [ # MySQL columns in the database. When unspecified as part of include/exclude lists, includes/excludes everything.
{ # MySQL Column.
"collation": "A String", # Column collation.
"columnName": "A String", # Column name.
"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
"length": 42, # Column length.
"nullable": True or False, # Whether or not the column can accept a null value.
"ordinalPosition": 42, # The ordinal position of the column in the table.
"primaryKey": True or False, # Whether or not the column represents a primary key.
},
],
"tableName": "A String", # Table name.
},
],
},
],
},
},
"oracleSourceConfig": { # Oracle data source configuration # Oracle data source configuration
"allowlist": { # Oracle database structure. # Oracle objects to include in the stream.
"oracleSchemas": [ # Oracle schemas/databases in the database server.
{ # Oracle schema.
"oracleTables": [ # Tables in the schema.
{ # Oracle table.
"oracleColumns": [ # Oracle columns in the schema. When unspecified as part of inclue/exclude lists, includes/excludes everything.
{ # Oracle Column.
"columnName": "A String", # Column name.
"dataType": "A String", # The Oracle data type.
"encoding": "A String", # Column encoding.
"length": 42, # Column length.
"nullable": True or False, # Whether or not the column can accept a null value.
"ordinalPosition": 42, # The ordinal position of the column in the table.
"precision": 42, # Column precision.
"primaryKey": True or False, # Whether or not the column represents a primary key.
"scale": 42, # Column scale.
},
],
"tableName": "A String", # Table name.
},
],
"schemaName": "A String", # Schema name.
},
],
},
"rejectlist": { # Oracle database structure. # Oracle objects to exclude from the stream.
"oracleSchemas": [ # Oracle schemas/databases in the database server.
{ # Oracle schema.
"oracleTables": [ # Tables in the schema.
{ # Oracle table.
"oracleColumns": [ # Oracle columns in the schema. When unspecified as part of inclue/exclude lists, includes/excludes everything.
{ # Oracle Column.
"columnName": "A String", # Column name.
"dataType": "A String", # The Oracle data type.
"encoding": "A String", # Column encoding.
"length": 42, # Column length.
"nullable": True or False, # Whether or not the column can accept a null value.
"ordinalPosition": 42, # The ordinal position of the column in the table.
"precision": 42, # Column precision.
"primaryKey": True or False, # Whether or not the column represents a primary key.
"scale": 42, # Column scale.
},
],
"tableName": "A String", # Table name.
},
],
"schemaName": "A String", # Schema name.
},
],
},
},
"sourceConnectionProfileName": "A String", # Required. Source connection profile identifier.
},
"state": "A String", # The state of the stream.
"updateTime": "A String", # Output only. The last update time of the stream.
}
list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
Use this method to list streams in a project and location.
Args:
parent: string, Required. The parent that owns the collection of streams. (required)
filter: string, Filter request.
orderBy: string, Order by fields for the result.
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.
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.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"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.
"streams": [ # List of streams
{
"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.
"mysqlExcludedObjects": { # MySQL database structure # MySQL data source objects to avoid backfilling.
"mysqlDatabases": [ # Mysql databases on the server
{ # MySQL database.
"databaseName": "A String", # Database name.
"mysqlTables": [ # Tables in the database.
{ # MySQL table.
"mysqlColumns": [ # MySQL columns in the database. When unspecified as part of include/exclude lists, includes/excludes everything.
{ # MySQL Column.
"collation": "A String", # Column collation.
"columnName": "A String", # Column name.
"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
"length": 42, # Column length.
"nullable": True or False, # Whether or not the column can accept a null value.
"ordinalPosition": 42, # The ordinal position of the column in the table.
"primaryKey": True or False, # Whether or not the column represents a primary key.
},
],
"tableName": "A String", # Table name.
},
],
},
],
},
"oracleExcludedObjects": { # Oracle database structure. # Oracle data source objects to avoid backfilling.
"oracleSchemas": [ # Oracle schemas/databases in the database server.
{ # Oracle schema.
"oracleTables": [ # Tables in the schema.
{ # Oracle table.
"oracleColumns": [ # Oracle columns in the schema. When unspecified as part of inclue/exclude lists, includes/excludes everything.
{ # Oracle Column.
"columnName": "A String", # Column name.
"dataType": "A String", # The Oracle data type.
"encoding": "A String", # Column encoding.
"length": 42, # Column length.
"nullable": True or False, # Whether or not the column can accept a null value.
"ordinalPosition": 42, # The ordinal position of the column in the table.
"precision": 42, # Column precision.
"primaryKey": True or False, # Whether or not the column represents a primary key.
"scale": 42, # Column scale.
},
],
"tableName": "A String", # Table name.
},
],
"schemaName": "A String", # Schema name.
},
],
},
},
"backfillNone": { # Backfill strategy to disable automatic backfill for the Stream's objects. # Do not automatically backfill any objects.
},
"createTime": "A String", # Output only. The creation time of the stream.
"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.
"destinationConfig": { # The configuration of the stream destination. # Required. Destination connection profile configuration.
"destinationConnectionProfileName": "A String", # Required. Destination connection profile identifier.
"gcsDestinationConfig": { # Google Cloud Storage destination configuration
"avroFileFormat": { # AVRO file format configuration. # AVRO file format configuration.
},
"fileRotationInterval": "A String", # The maximum duration for which new events are added before a file is closed and a new file is created.
"fileRotationMb": 42, # The maximum file size to be saved in the bucket.
"gcsFileFormat": "A String", # File format that data should be written in. Deprecated field (b/169501737) - use file_format instead.
"jsonFileFormat": { # JSON file format configuration. # JSON file format configuration.
"compression": "A String", # Compression of the loaded JSON file.
"schemaFileFormat": "A String", # The schema file format along JSON data files.
},
"path": "A String", # Path inside the Cloud Storage bucket to write data to.
},
},
"displayName": "A String", # Required. Display name.
"errors": [ # Output only. Errors on the Stream.
{ # Represent a user-facing Error.
"details": { # Additional information about the error.
"a_key": "A String",
},
"errorTime": "A String", # The time when the error occurred.
"errorUuid": "A String", # A unique identifier for this specific error, allowing it to be traced throughout the system in logs and API responses.
"message": "A String", # A message containing more information about the error that occurred.
"reason": "A String", # A title that explains the reason for the error.
},
],
"labels": { # Labels.
"a_key": "A String",
},
"name": "A String", # Output only. The stream's name.
"sourceConfig": { # The configuration of the stream source. # Required. Source connection profile configuration.
"mysqlSourceConfig": { # MySQL source configuration # MySQL data source configuration
"allowlist": { # MySQL database structure # MySQL objects to retrieve from the source.
"mysqlDatabases": [ # Mysql databases on the server
{ # MySQL database.
"databaseName": "A String", # Database name.
"mysqlTables": [ # Tables in the database.
{ # MySQL table.
"mysqlColumns": [ # MySQL columns in the database. When unspecified as part of include/exclude lists, includes/excludes everything.
{ # MySQL Column.
"collation": "A String", # Column collation.
"columnName": "A String", # Column name.
"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
"length": 42, # Column length.
"nullable": True or False, # Whether or not the column can accept a null value.
"ordinalPosition": 42, # The ordinal position of the column in the table.
"primaryKey": True or False, # Whether or not the column represents a primary key.
},
],
"tableName": "A String", # Table name.
},
],
},
],
},
"rejectlist": { # MySQL database structure # MySQL objects to exclude from the stream.
"mysqlDatabases": [ # Mysql databases on the server
{ # MySQL database.
"databaseName": "A String", # Database name.
"mysqlTables": [ # Tables in the database.
{ # MySQL table.
"mysqlColumns": [ # MySQL columns in the database. When unspecified as part of include/exclude lists, includes/excludes everything.
{ # MySQL Column.
"collation": "A String", # Column collation.
"columnName": "A String", # Column name.
"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
"length": 42, # Column length.
"nullable": True or False, # Whether or not the column can accept a null value.
"ordinalPosition": 42, # The ordinal position of the column in the table.
"primaryKey": True or False, # Whether or not the column represents a primary key.
},
],
"tableName": "A String", # Table name.
},
],
},
],
},
},
"oracleSourceConfig": { # Oracle data source configuration # Oracle data source configuration
"allowlist": { # Oracle database structure. # Oracle objects to include in the stream.
"oracleSchemas": [ # Oracle schemas/databases in the database server.
{ # Oracle schema.
"oracleTables": [ # Tables in the schema.
{ # Oracle table.
"oracleColumns": [ # Oracle columns in the schema. When unspecified as part of inclue/exclude lists, includes/excludes everything.
{ # Oracle Column.
"columnName": "A String", # Column name.
"dataType": "A String", # The Oracle data type.
"encoding": "A String", # Column encoding.
"length": 42, # Column length.
"nullable": True or False, # Whether or not the column can accept a null value.
"ordinalPosition": 42, # The ordinal position of the column in the table.
"precision": 42, # Column precision.
"primaryKey": True or False, # Whether or not the column represents a primary key.
"scale": 42, # Column scale.
},
],
"tableName": "A String", # Table name.
},
],
"schemaName": "A String", # Schema name.
},
],
},
"rejectlist": { # Oracle database structure. # Oracle objects to exclude from the stream.
"oracleSchemas": [ # Oracle schemas/databases in the database server.
{ # Oracle schema.
"oracleTables": [ # Tables in the schema.
{ # Oracle table.
"oracleColumns": [ # Oracle columns in the schema. When unspecified as part of inclue/exclude lists, includes/excludes everything.
{ # Oracle Column.
"columnName": "A String", # Column name.
"dataType": "A String", # The Oracle data type.
"encoding": "A String", # Column encoding.
"length": 42, # Column length.
"nullable": True or False, # Whether or not the column can accept a null value.
"ordinalPosition": 42, # The ordinal position of the column in the table.
"precision": 42, # Column precision.
"primaryKey": True or False, # Whether or not the column represents a primary key.
"scale": 42, # Column scale.
},
],
"tableName": "A String", # Table name.
},
],
"schemaName": "A String", # Schema name.
},
],
},
},
"sourceConnectionProfileName": "A String", # Required. Source connection profile identifier.
},
"state": "A String", # The state of the stream.
"updateTime": "A String", # Output only. The last update time of the stream.
},
],
"unreachable": [ # Locations that could not be reached.
"A String",
],
}
list_next(previous_request, previous_response)
Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
patch(name, body=None, force=None, requestId=None, updateMask=None, validateOnly=None, x__xgafv=None)
Use this method to update the configuration of a stream.
Args:
name: string, Output only. The stream's name. (required)
body: object, The request body.
The object takes the form of:
{
"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.
"mysqlExcludedObjects": { # MySQL database structure # MySQL data source objects to avoid backfilling.
"mysqlDatabases": [ # Mysql databases on the server
{ # MySQL database.
"databaseName": "A String", # Database name.
"mysqlTables": [ # Tables in the database.
{ # MySQL table.
"mysqlColumns": [ # MySQL columns in the database. When unspecified as part of include/exclude lists, includes/excludes everything.
{ # MySQL Column.
"collation": "A String", # Column collation.
"columnName": "A String", # Column name.
"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
"length": 42, # Column length.
"nullable": True or False, # Whether or not the column can accept a null value.
"ordinalPosition": 42, # The ordinal position of the column in the table.
"primaryKey": True or False, # Whether or not the column represents a primary key.
},
],
"tableName": "A String", # Table name.
},
],
},
],
},
"oracleExcludedObjects": { # Oracle database structure. # Oracle data source objects to avoid backfilling.
"oracleSchemas": [ # Oracle schemas/databases in the database server.
{ # Oracle schema.
"oracleTables": [ # Tables in the schema.
{ # Oracle table.
"oracleColumns": [ # Oracle columns in the schema. When unspecified as part of inclue/exclude lists, includes/excludes everything.
{ # Oracle Column.
"columnName": "A String", # Column name.
"dataType": "A String", # The Oracle data type.
"encoding": "A String", # Column encoding.
"length": 42, # Column length.
"nullable": True or False, # Whether or not the column can accept a null value.
"ordinalPosition": 42, # The ordinal position of the column in the table.
"precision": 42, # Column precision.
"primaryKey": True or False, # Whether or not the column represents a primary key.
"scale": 42, # Column scale.
},
],
"tableName": "A String", # Table name.
},
],
"schemaName": "A String", # Schema name.
},
],
},
},
"backfillNone": { # Backfill strategy to disable automatic backfill for the Stream's objects. # Do not automatically backfill any objects.
},
"createTime": "A String", # Output only. The creation time of the stream.
"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.
"destinationConfig": { # The configuration of the stream destination. # Required. Destination connection profile configuration.
"destinationConnectionProfileName": "A String", # Required. Destination connection profile identifier.
"gcsDestinationConfig": { # Google Cloud Storage destination configuration
"avroFileFormat": { # AVRO file format configuration. # AVRO file format configuration.
},
"fileRotationInterval": "A String", # The maximum duration for which new events are added before a file is closed and a new file is created.
"fileRotationMb": 42, # The maximum file size to be saved in the bucket.
"gcsFileFormat": "A String", # File format that data should be written in. Deprecated field (b/169501737) - use file_format instead.
"jsonFileFormat": { # JSON file format configuration. # JSON file format configuration.
"compression": "A String", # Compression of the loaded JSON file.
"schemaFileFormat": "A String", # The schema file format along JSON data files.
},
"path": "A String", # Path inside the Cloud Storage bucket to write data to.
},
},
"displayName": "A String", # Required. Display name.
"errors": [ # Output only. Errors on the Stream.
{ # Represent a user-facing Error.
"details": { # Additional information about the error.
"a_key": "A String",
},
"errorTime": "A String", # The time when the error occurred.
"errorUuid": "A String", # A unique identifier for this specific error, allowing it to be traced throughout the system in logs and API responses.
"message": "A String", # A message containing more information about the error that occurred.
"reason": "A String", # A title that explains the reason for the error.
},
],
"labels": { # Labels.
"a_key": "A String",
},
"name": "A String", # Output only. The stream's name.
"sourceConfig": { # The configuration of the stream source. # Required. Source connection profile configuration.
"mysqlSourceConfig": { # MySQL source configuration # MySQL data source configuration
"allowlist": { # MySQL database structure # MySQL objects to retrieve from the source.
"mysqlDatabases": [ # Mysql databases on the server
{ # MySQL database.
"databaseName": "A String", # Database name.
"mysqlTables": [ # Tables in the database.
{ # MySQL table.
"mysqlColumns": [ # MySQL columns in the database. When unspecified as part of include/exclude lists, includes/excludes everything.
{ # MySQL Column.
"collation": "A String", # Column collation.
"columnName": "A String", # Column name.
"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
"length": 42, # Column length.
"nullable": True or False, # Whether or not the column can accept a null value.
"ordinalPosition": 42, # The ordinal position of the column in the table.
"primaryKey": True or False, # Whether or not the column represents a primary key.
},
],
"tableName": "A String", # Table name.
},
],
},
],
},
"rejectlist": { # MySQL database structure # MySQL objects to exclude from the stream.
"mysqlDatabases": [ # Mysql databases on the server
{ # MySQL database.
"databaseName": "A String", # Database name.
"mysqlTables": [ # Tables in the database.
{ # MySQL table.
"mysqlColumns": [ # MySQL columns in the database. When unspecified as part of include/exclude lists, includes/excludes everything.
{ # MySQL Column.
"collation": "A String", # Column collation.
"columnName": "A String", # Column name.
"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
"length": 42, # Column length.
"nullable": True or False, # Whether or not the column can accept a null value.
"ordinalPosition": 42, # The ordinal position of the column in the table.
"primaryKey": True or False, # Whether or not the column represents a primary key.
},
],
"tableName": "A String", # Table name.
},
],
},
],
},
},
"oracleSourceConfig": { # Oracle data source configuration # Oracle data source configuration
"allowlist": { # Oracle database structure. # Oracle objects to include in the stream.
"oracleSchemas": [ # Oracle schemas/databases in the database server.
{ # Oracle schema.
"oracleTables": [ # Tables in the schema.
{ # Oracle table.
"oracleColumns": [ # Oracle columns in the schema. When unspecified as part of inclue/exclude lists, includes/excludes everything.
{ # Oracle Column.
"columnName": "A String", # Column name.
"dataType": "A String", # The Oracle data type.
"encoding": "A String", # Column encoding.
"length": 42, # Column length.
"nullable": True or False, # Whether or not the column can accept a null value.
"ordinalPosition": 42, # The ordinal position of the column in the table.
"precision": 42, # Column precision.
"primaryKey": True or False, # Whether or not the column represents a primary key.
"scale": 42, # Column scale.
},
],
"tableName": "A String", # Table name.
},
],
"schemaName": "A String", # Schema name.
},
],
},
"rejectlist": { # Oracle database structure. # Oracle objects to exclude from the stream.
"oracleSchemas": [ # Oracle schemas/databases in the database server.
{ # Oracle schema.
"oracleTables": [ # Tables in the schema.
{ # Oracle table.
"oracleColumns": [ # Oracle columns in the schema. When unspecified as part of inclue/exclude lists, includes/excludes everything.
{ # Oracle Column.
"columnName": "A String", # Column name.
"dataType": "A String", # The Oracle data type.
"encoding": "A String", # Column encoding.
"length": 42, # Column length.
"nullable": True or False, # Whether or not the column can accept a null value.
"ordinalPosition": 42, # The ordinal position of the column in the table.
"precision": 42, # Column precision.
"primaryKey": True or False, # Whether or not the column represents a primary key.
"scale": 42, # Column scale.
},
],
"tableName": "A String", # Table name.
},
],
"schemaName": "A String", # Schema name.
},
],
},
},
"sourceConnectionProfileName": "A String", # Required. Source connection profile identifier.
},
"state": "A String", # The state of the stream.
"updateTime": "A String", # Output only. The last update time of the stream.
}
force: boolean, Optional. Execute the update without validating it.
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).
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.
validateOnly: boolean, Optional. Only validate the stream with the changes, without actually updating it. The default is false.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"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.
"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.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"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.
},
"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.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"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}`.
"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`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}