Package types (1.11.0)

API documentation for datastream_v1.types package.

Classes

AvroFileFormat

AVRO file format configuration.

BackfillJob

Represents a backfill job on a specific stream object.

BigQueryDestinationConfig

BigQuery destination configuration

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

BigQueryProfile

BigQuery warehouse profile.

CdcStrategy

The strategy that the stream uses for CDC replication.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

ConnectionProfile

A set of reusable connection configurations to be used as a source or destination for a stream.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

CreateConnectionProfileRequest

Request message for creating a connection profile.

CreatePrivateConnectionRequest

Request for creating a private connection.

CreateRouteRequest

Route creation request.

CreateStreamRequest

Request message for creating a stream.

DeleteConnectionProfileRequest

Request message for deleting a connection profile.

DeletePrivateConnectionRequest

Request to delete a private connection.

DeleteRouteRequest

Route deletion request.

DeleteStreamRequest

Request message for deleting a stream.

DestinationConfig

The configuration of the stream destination.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

DiscoverConnectionProfileRequest

Request message for 'discover' ConnectionProfile request.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

DiscoverConnectionProfileResponse

Response from a discover request.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Error

Represent a user-facing Error.

FetchStaticIpsRequest

Request message for 'FetchStaticIps' request.

FetchStaticIpsResponse

Response message for a 'FetchStaticIps' response.

ForwardSshTunnelConnectivity

Forward SSH Tunnel connectivity.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

GcsDestinationConfig

Google Cloud Storage destination configuration

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

GcsProfile

Cloud Storage bucket profile.

GetConnectionProfileRequest

Request message for getting a connection profile.

GetPrivateConnectionRequest

Request to get a private connection configuration.

GetRouteRequest

Route get request.

GetStreamObjectRequest

Request for fetching a specific stream object.

GetStreamRequest

Request message for getting a stream.

JsonFileFormat

JSON file format configuration.

ListConnectionProfilesRequest

Request message for listing connection profiles.

ListConnectionProfilesResponse

Response message for listing connection profiles.

ListPrivateConnectionsRequest

Request for listing private connections.

ListPrivateConnectionsResponse

Response containing a list of private connection configurations.

ListRoutesRequest

Route list request.

ListRoutesResponse

Route list response.

ListStreamObjectsRequest

Request for listing all objects for a specific stream.

ListStreamObjectsResponse

Response containing the objects for a stream.

ListStreamsRequest

Request message for listing streams.

ListStreamsResponse

Response message for listing streams.

LookupStreamObjectRequest

Request for looking up a specific stream object by its source object identifier.

MysqlColumn

MySQL Column.

MysqlDatabase

MySQL database.

MysqlLogPosition

MySQL log position

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

MysqlProfile

MySQL database profile. Next ID: 7.

MysqlRdbms

MySQL database structure

MysqlSourceConfig

MySQL source configuration

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

MysqlSslConfig

MySQL SSL configuration information.

MysqlTable

MySQL table.

OperationMetadata

Represents the metadata of the long-running operation.

OracleAsmConfig

Configuration for Oracle Automatic Storage Management (ASM) connection.

OracleColumn

Oracle Column.

OracleProfile

Oracle database profile. Next ID: 10.

OracleRdbms

Oracle database structure.

OracleSchema

Oracle schema.

OracleScnPosition

Oracle SCN position

OracleSourceConfig

Oracle data source configuration

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

OracleSslConfig

Oracle SSL configuration information.

OracleTable

Oracle table.

PostgresqlColumn

PostgreSQL Column.

PostgresqlProfile

PostgreSQL database profile.

PostgresqlRdbms

PostgreSQL database structure.

PostgresqlSchema

PostgreSQL schema.

PostgresqlSourceConfig

PostgreSQL data source configuration

PostgresqlTable

PostgreSQL table.

PrivateConnection

The PrivateConnection resource is used to establish private connectivity between Datastream and a customer's network.

PrivateConnectivity

Private Connectivity

Route

The route resource is the child of the private connection resource, used for defining a route for a private connection.

RunStreamRequest

Request message for running a stream.

SourceConfig

The configuration of the stream source.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

SourceObjectIdentifier

Represents an identifier of an object in the data source.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

SqlServerChangeTables

Configuration to use Change Tables CDC read method.

SqlServerColumn

SQLServer Column.

SqlServerLsnPosition

SQL Server LSN position

SqlServerProfile

SQLServer database profile. Next ID: 8.

SqlServerRdbms

SQLServer database structure.

SqlServerSchema

SQLServer schema.

SqlServerSourceConfig

SQLServer data source configuration

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

SqlServerTable

SQLServer table.

SqlServerTransactionLogs

Configuration to use Transaction Logs CDC read method.

StartBackfillJobRequest

Request for manually initiating a backfill job for a specific stream object.

StartBackfillJobResponse

Response for manually initiating a backfill job for a specific stream object.

StaticServiceIpConnectivity

Static IP address connectivity. Used when the source database is configured to allow incoming connections from the Datastream public IP addresses for the region specified in the connection profile.

StopBackfillJobRequest

Request for manually stopping a running backfill job for a specific stream object.

StopBackfillJobResponse

Response for manually stop a backfill job for a specific stream object.

Stream

A resource representing streaming data from a source to a destination.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

StreamObject

A specific stream object (e.g a specific DB table).

UpdateConnectionProfileRequest

Connection profile update message.

UpdateStreamRequest

Request message for updating a stream.

Validation

A validation to perform on a stream.

ValidationMessage

Represent user-facing validation result message.

ValidationResult

Contains the current validation results.

VpcPeeringConfig

The VPC Peering configuration is used to create VPC peering between Datastream and the consumer's VPC.