Package Classes (1.11.0)

Summary of entries of Classes for datastream.

Classes

FetchStaticIpsAsyncPager

A pager for iterating through fetch_static_ips requests.

This class thinly wraps an initial FetchStaticIpsResponse object, and provides an __aiter__ method to iterate through its static_ips field.

If there are more pages, the __aiter__ method will make additional FetchStaticIps requests and continue to iterate through the static_ips field on the corresponding responses.

All the usual FetchStaticIpsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

FetchStaticIpsPager

A pager for iterating through fetch_static_ips requests.

This class thinly wraps an initial FetchStaticIpsResponse object, and provides an __iter__ method to iterate through its static_ips field.

If there are more pages, the __iter__ method will make additional FetchStaticIps requests and continue to iterate through the static_ips field on the corresponding responses.

All the usual FetchStaticIpsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListConnectionProfilesAsyncPager

A pager for iterating through list_connection_profiles requests.

This class thinly wraps an initial ListConnectionProfilesResponse object, and provides an __aiter__ method to iterate through its connection_profiles field.

If there are more pages, the __aiter__ method will make additional ListConnectionProfiles requests and continue to iterate through the connection_profiles field on the corresponding responses.

All the usual ListConnectionProfilesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListConnectionProfilesPager

A pager for iterating through list_connection_profiles requests.

This class thinly wraps an initial ListConnectionProfilesResponse object, and provides an __iter__ method to iterate through its connection_profiles field.

If there are more pages, the __iter__ method will make additional ListConnectionProfiles requests and continue to iterate through the connection_profiles field on the corresponding responses.

All the usual ListConnectionProfilesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListPrivateConnectionsAsyncPager

A pager for iterating through list_private_connections requests.

This class thinly wraps an initial ListPrivateConnectionsResponse object, and provides an __aiter__ method to iterate through its private_connections field.

If there are more pages, the __aiter__ method will make additional ListPrivateConnections requests and continue to iterate through the private_connections field on the corresponding responses.

All the usual ListPrivateConnectionsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListPrivateConnectionsPager

A pager for iterating through list_private_connections requests.

This class thinly wraps an initial ListPrivateConnectionsResponse object, and provides an __iter__ method to iterate through its private_connections field.

If there are more pages, the __iter__ method will make additional ListPrivateConnections requests and continue to iterate through the private_connections field on the corresponding responses.

All the usual ListPrivateConnectionsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListRoutesAsyncPager

A pager for iterating through list_routes requests.

This class thinly wraps an initial ListRoutesResponse object, and provides an __aiter__ method to iterate through its routes field.

If there are more pages, the __aiter__ method will make additional ListRoutes requests and continue to iterate through the routes field on the corresponding responses.

All the usual ListRoutesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListRoutesPager

A pager for iterating through list_routes requests.

This class thinly wraps an initial ListRoutesResponse object, and provides an __iter__ method to iterate through its routes field.

If there are more pages, the __iter__ method will make additional ListRoutes requests and continue to iterate through the routes field on the corresponding responses.

All the usual ListRoutesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListStreamObjectsAsyncPager

A pager for iterating through list_stream_objects requests.

This class thinly wraps an initial ListStreamObjectsResponse object, and provides an __aiter__ method to iterate through its stream_objects field.

If there are more pages, the __aiter__ method will make additional ListStreamObjects requests and continue to iterate through the stream_objects field on the corresponding responses.

All the usual ListStreamObjectsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListStreamObjectsPager

A pager for iterating through list_stream_objects requests.

This class thinly wraps an initial ListStreamObjectsResponse object, and provides an __iter__ method to iterate through its stream_objects field.

If there are more pages, the __iter__ method will make additional ListStreamObjects requests and continue to iterate through the stream_objects field on the corresponding responses.

All the usual ListStreamObjectsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListStreamsAsyncPager

A pager for iterating through list_streams requests.

This class thinly wraps an initial ListStreamsResponse object, and provides an __aiter__ method to iterate through its streams field.

If there are more pages, the __aiter__ method will make additional ListStreams requests and continue to iterate through the streams field on the corresponding responses.

All the usual ListStreamsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListStreamsPager

A pager for iterating through list_streams requests.

This class thinly wraps an initial ListStreamsResponse object, and provides an __iter__ method to iterate through its streams field.

If there are more pages, the __iter__ method will make additional ListStreams requests and continue to iterate through the streams field on the corresponding responses.

All the usual ListStreamsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

BackfillJob

Represents a backfill job on a specific stream object.

State

State of the stream object's backfill job.

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

AppendOnly

AppendOnly mode defines that all changes to a table will be written to the destination table.

Merge

Merge mode defines that all changes to a table will be merged at the destination table.

SingleTargetDataset

A single target dataset to which all data will be streamed.

SourceHierarchyDatasets

Destination datasets are created so that hierarchy of the destination data objects matches the source hierarchy.

DatasetTemplate

Dataset template used for dynamic dataset creation.

BigQueryProfile

BigQuery warehouse profile.

CdcStrategy

The strategy that the stream uses for CDC replication.

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

MostRecentStartPosition

CDC strategy to start replicating from the most recent position in the source.

NextAvailableStartPosition

CDC strategy to resume replication from the next available position in the source.

SpecificStartPosition

CDC strategy to start replicating from a specific position in the source.

.. _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.

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

LabelsEntry

The abstract base class for a message.

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.

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

DiscoverConnectionProfileRequest

Request message for 'discover' ConnectionProfile request.

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

DiscoverConnectionProfileResponse

Response from a discover request.

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

Error

Represent a user-facing Error.

DetailsEntry

The abstract base class for a message.

FetchStaticIpsRequest

Request message for 'FetchStaticIps' request.

FetchStaticIpsResponse

Response message for a 'FetchStaticIps' response.

ForwardSshTunnelConnectivity

Forward SSH Tunnel connectivity.

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

GcsDestinationConfig

Google Cloud Storage destination configuration

.. _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.

JsonCompression

Json file compression.

SchemaFileFormat

Schema file format.

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

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

BinaryLogPosition

Use Binary log position based replication.

Gtid

Use GTID based replication.

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.

ConnectionAttributesEntry

The abstract base class for a message.

OracleColumn

Oracle Column.

OracleProfile

Oracle database profile. Next ID: 10.

ConnectionAttributesEntry

The abstract base class for a message.

OracleRdbms

Oracle database structure.

OracleSchema

Oracle schema.

OracleScnPosition

Oracle SCN position

OracleSourceConfig

Oracle data source configuration

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

BinaryLogParser

Configuration to use Binary Log Parser CDC technique.

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

LogFileDirectories

Configuration to specify the Oracle directories to access the log files.

OracleAsmLogFileAccess

Configuration to use Oracle ASM to access the log files.

DropLargeObjects

Configuration to drop large object values.

LogMiner

Configuration to use LogMiner CDC method.

StreamLargeObjects

Configuration to stream large object values.

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.

LabelsEntry

The abstract base class for a message.

State

Private Connection state.

PrivateConnectivity

Private Connectivity

Route

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

LabelsEntry

The abstract base class for a message.

RunStreamRequest

Request message for running a stream.

SourceConfig

The configuration of the stream source.

.. _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.

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

MysqlObjectIdentifier

Mysql data source object identifier.

OracleObjectIdentifier

Oracle data source object identifier.

PostgresqlObjectIdentifier

PostgreSQL data source object identifier.

SqlServerObjectIdentifier

SQLServer data source object identifier.

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

.. _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.

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

BackfillAllStrategy

Backfill strategy to automatically backfill the Stream's objects. Specific objects can be excluded.

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

BackfillNoneStrategy

Backfill strategy to disable automatic backfill for the Stream's objects.

LabelsEntry

The abstract base class for a message.

State

Stream state.

    Updates are rejected on the resource in this
    state.
FAILED (5):
    The stream is experiencing an error that is
    preventing data from being streamed.
FAILED_PERMANENTLY (6):
    The stream has experienced a terminal
    failure.
STARTING (7):
    The stream is starting, but not yet running.
DRAINING (8):
    The Stream is no longer reading new events,
    but still writing events in the buffer.

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.

State

Validation execution state.

ValidationMessage

Represent user-facing validation result message.

Level

Validation message level.

MetadataEntry

The abstract base class for a 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.

DatastreamAsyncClient

Datastream service

DatastreamClient

Datastream service

FetchStaticIpsAsyncPager

A pager for iterating through fetch_static_ips requests.

This class thinly wraps an initial FetchStaticIpsResponse object, and provides an __aiter__ method to iterate through its static_ips field.

If there are more pages, the __aiter__ method will make additional FetchStaticIps requests and continue to iterate through the static_ips field on the corresponding responses.

All the usual FetchStaticIpsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

FetchStaticIpsPager

A pager for iterating through fetch_static_ips requests.

This class thinly wraps an initial FetchStaticIpsResponse object, and provides an __iter__ method to iterate through its static_ips field.

If there are more pages, the __iter__ method will make additional FetchStaticIps requests and continue to iterate through the static_ips field on the corresponding responses.

All the usual FetchStaticIpsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListConnectionProfilesAsyncPager

A pager for iterating through list_connection_profiles requests.

This class thinly wraps an initial ListConnectionProfilesResponse object, and provides an __aiter__ method to iterate through its connection_profiles field.

If there are more pages, the __aiter__ method will make additional ListConnectionProfiles requests and continue to iterate through the connection_profiles field on the corresponding responses.

All the usual ListConnectionProfilesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListConnectionProfilesPager

A pager for iterating through list_connection_profiles requests.

This class thinly wraps an initial ListConnectionProfilesResponse object, and provides an __iter__ method to iterate through its connection_profiles field.

If there are more pages, the __iter__ method will make additional ListConnectionProfiles requests and continue to iterate through the connection_profiles field on the corresponding responses.

All the usual ListConnectionProfilesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListPrivateConnectionsAsyncPager

A pager for iterating through list_private_connections requests.

This class thinly wraps an initial ListPrivateConnectionsResponse object, and provides an __aiter__ method to iterate through its private_connections field.

If there are more pages, the __aiter__ method will make additional ListPrivateConnections requests and continue to iterate through the private_connections field on the corresponding responses.

All the usual ListPrivateConnectionsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListPrivateConnectionsPager

A pager for iterating through list_private_connections requests.

This class thinly wraps an initial ListPrivateConnectionsResponse object, and provides an __iter__ method to iterate through its private_connections field.

If there are more pages, the __iter__ method will make additional ListPrivateConnections requests and continue to iterate through the private_connections field on the corresponding responses.

All the usual ListPrivateConnectionsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListRoutesAsyncPager

A pager for iterating through list_routes requests.

This class thinly wraps an initial ListRoutesResponse object, and provides an __aiter__ method to iterate through its routes field.

If there are more pages, the __aiter__ method will make additional ListRoutes requests and continue to iterate through the routes field on the corresponding responses.

All the usual ListRoutesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListRoutesPager

A pager for iterating through list_routes requests.

This class thinly wraps an initial ListRoutesResponse object, and provides an __iter__ method to iterate through its routes field.

If there are more pages, the __iter__ method will make additional ListRoutes requests and continue to iterate through the routes field on the corresponding responses.

All the usual ListRoutesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListStreamsAsyncPager

A pager for iterating through list_streams requests.

This class thinly wraps an initial ListStreamsResponse object, and provides an __aiter__ method to iterate through its streams field.

If there are more pages, the __aiter__ method will make additional ListStreams requests and continue to iterate through the streams field on the corresponding responses.

All the usual ListStreamsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListStreamsPager

A pager for iterating through list_streams requests.

This class thinly wraps an initial ListStreamsResponse object, and provides an __iter__ method to iterate through its streams field.

If there are more pages, the __iter__ method will make additional ListStreams requests and continue to iterate through the streams field on the corresponding responses.

All the usual ListStreamsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

    Updates are rejected on the resource in this
    state.
FAILED (5):
    The stream is experiencing an error that is
    preventing data from being streamed.
FAILED_PERMANENTLY (6):
    The stream has experienced a terminal
    failure.
STARTING (7):
    The stream is starting, but not yet running.
DRAINING (8):
    The Stream is no longer reading new events,
    but still writing events in the buffer.

Modules

pagers

API documentation for datastream_v1.services.datastream.pagers module.

pagers

API documentation for datastream_v1alpha1.services.datastream.pagers module.