datastream/v1 library
Datastream API - v1
For more information, see cloud.google.com/datastream/
Create an instance of DatastreamApi to access these resources:
Classes
- BackfillAllStrategy
- Backfill strategy to automatically backfill the Stream's objects.
- BackfillJob
- Represents a backfill job on a specific stream object.
- BigQueryClustering
- BigQuery clustering configuration.
- BigQueryDestinationConfig
- BigQuery destination configuration
- BigQueryPartitioning
- BigQuery partitioning configuration.
- BinaryLogParser
- Configuration to use Binary Log Parser CDC technique.
- BlmtConfig
- The configuration for BLMT.
- CdcStrategy
- The strategy that the stream uses for CDC replication.
- ConnectionProfile
- A set of reusable connection configurations to be used as a source or destination for a stream.
- CustomizationRule
- A customization rule to apply to a set of objects.
- DatasetTemplate
- Dataset template used for dynamic dataset creation.
- DatastreamApi
- DestinationConfig
- The configuration of the stream destination.
- DiscoverConnectionProfileRequest
- Request message for 'discover' ConnectionProfile request.
- DiscoverConnectionProfileResponse
- Response from a discover request.
- EncryptionAndServerValidation
- Message to represent the option where Datastream will enforce encryption and authenticate server identity.
- Error
- Represent a user-facing Error.
- EventFilter
- Represents a filter for included data on a stream object.
- FetchStaticIpsResponse
- Response message for a 'FetchStaticIps' response.
- GcsDestinationConfig
- Google Cloud Storage destination configuration
- GcsProfile
- Profile for connecting to a Cloud Storage destination.
- HostAddress
- A HostAddress represents a transport end point, which is the combination of an IP address or hostname and a port number.
- IngestionTimePartition
- Ingestion time partitioning.
- IntegerRangePartition
- Integer range partitioning.
- JsonFileFormat
- JSON file format configuration.
- ListConnectionProfilesResponse
- Response message for listing connection profiles.
- ListLocationsResponse
- The response message for Locations.ListLocations.
- ListOperationsResponse
- The response message for Operations.ListOperations.
- ListPrivateConnectionsResponse
- Response containing a list of private connection configurations.
- ListRoutesResponse
- Route list response.
- ListStreamObjectsResponse
- Response containing the objects for a stream.
- ListStreamsResponse
- Response message for listing streams.
- LookupStreamObjectRequest
- Request for looking up a specific stream object by its source object identifier.
- MongodbChangeStreamPosition
- MongoDB change stream position
- MongodbCluster
- MongoDB Cluster structure.
- MongodbCollection
- MongoDB Collection.
- MongodbDatabase
- MongoDB Database.
- MongodbField
- MongoDB Field.
- MongodbObjectIdentifier
- MongoDB data source object identifier.
- MongodbProfile
- Profile for connecting to a MongoDB source.
- MongodbSourceConfig
- Configuration for syncing data from a MongoDB source.
- MongodbSslConfig
- MongoDB SSL configuration information.
- MysqlColumn
- MySQL Column.
- MysqlDatabase
- MySQL database.
- MysqlGtidPosition
- MySQL GTID position
- MysqlLogPosition
- MySQL log position
- MysqlObjectIdentifier
- Mysql data source object identifier.
- MysqlProfile
- Profile for connecting to a MySQL source.
- MysqlRdbms
- MySQL database structure
- MysqlSourceConfig
- Configuration for syncing data from a MySQL source.
- MysqlSslConfig
- MySQL SSL configuration information.
- MysqlTable
- MySQL table.
- Oauth2ClientCredentials
- OAuth2 Client Credentials.
- ObjectFilter
- Object filter to apply the rules to.
- Operation
- This resource represents a long-running operation that is the result of a network API call.
- OracleAsmConfig
- Configuration for Oracle Automatic Storage Management (ASM) connection.
- OracleColumn
- Oracle Column.
- OracleProfile
- Profile for connecting to an Oracle source.
- OracleRdbms
- Oracle database structure.
- OracleSchema
- Oracle schema.
- OracleScnPosition
- Oracle SCN position
- OracleSourceConfig
- Configuration for syncing data from an Oracle source.
- OracleSslConfig
- Oracle SSL configuration information.
- OracleTable
- Oracle table.
- PostgresqlColumn
- PostgreSQL Column.
- PostgresqlProfile
- Profile for connecting to a PostgreSQL source.
- PostgresqlRdbms
- PostgreSQL database structure.
- PostgresqlSchema
- PostgreSQL schema.
- PostgresqlSourceConfig
- Configuration for syncing data from a PostgreSQL source.
- PostgresqlSslConfig
- PostgreSQL SSL configuration information.
- PostgresqlTable
- PostgreSQL table.
- PrivateConnection
- The PrivateConnection resource is used to establish private connectivity between Datastream and a customer's network.
- PrivateConnectivity
- Private Connectivity
- ProjectsLocationsConnectionProfilesResource
- ProjectsLocationsOperationsResource
- ProjectsLocationsPrivateConnectionsResource
- ProjectsLocationsPrivateConnectionsRoutesResource
- ProjectsLocationsResource
- ProjectsLocationsStreamsObjectsResource
- ProjectsLocationsStreamsResource
- ProjectsResource
- PscInterfaceConfig
- The PSC Interface configuration is used to create PSC Interface between Datastream and the consumer's PSC.
- Route
- The route resource is the child of the private connection resource, used for defining a route for a private connection.
- RuleSet
- A set of rules to apply to a set of objects.
- RunStreamRequest
- Request message for running a stream.
- SalesforceField
- Salesforce field.
- SalesforceObject
- Salesforce object.
- SalesforceObjectIdentifier
- Salesforce data source object identifier.
- SalesforceOrg
- Salesforce organization structure.
- SalesforceProfile
- Profile for connecting to a Salesforce source.
- SalesforceSourceConfig
- Configuration for syncing data from a Salesforce source.
- ServerAndClientVerification
- Message represents the option where Datastream will enforce the encryption and authenticate the server identity as well as the client identity.
- ServerVerification
- Message represents the option where Datastream will enforce the encryption and authenticate the server identity.
- SingleTargetDataset
- A single target dataset to which all data will be streamed.
- SourceConfig
- The configuration of the stream source.
- SourceHierarchyDatasets
- Destination datasets are created so that hierarchy of the destination data objects matches the source hierarchy.
- SourceObjectIdentifier
- Represents an identifier of an object in the data source.
- SpannerColumn
- Spanner column.
- SpannerDatabase
- Spanner database structure.
- SpannerObjectIdentifier
- Spanner data source object identifier.
- SpannerProfile
- Profile for connecting to a Spanner source.
- SpannerSchema
- Spanner schema.
- SpannerSourceConfig
- Configuration for syncing data from a Spanner source.
- SpannerTable
- Spanner table.
- SpecificStartPosition
- CDC strategy to start replicating from a specific position in the source.
- SqlServerColumn
- SQLServer Column.
- SqlServerLsnPosition
- SQL Server LSN position
- SqlServerProfile
- Profile for connecting to a SQLServer source.
- SqlServerRdbms
- SQLServer database structure.
- SqlServerSchema
- SQLServer schema.
- SqlServerSourceConfig
- Configuration for syncing data from a SQLServer source.
- SqlServerSslConfig
- SQL Server SSL configuration information.
- SqlServerTable
- SQLServer table.
- StandardConnectionFormat
- Standard connection format.
- 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.
- 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.
- StreamObject
- A specific stream object (e.g a specific DB table).
- TimeUnitPartition
- Time unit column partitioning.
- UserCredentials
- Username-password credentials.
- VpcPeeringConfig
- The VPC Peering configuration is used to create VPC peering between Datastream and the consumer's VPC.
Typedefs
- AppendOnly = $Empty
- AppendOnly mode defines that all changes to a table will be written to the destination table.
- AvroFileFormat = $Empty
- AVRO file format configuration.
- BackfillNoneStrategy = $Empty
- Backfill strategy to disable automatic backfill for the Stream's objects.
- BasicEncryption = $Empty
- Message to represent the option where Datastream will enforce encryption without authenticating server identity.
- BigQueryProfile = $Empty
- Profile for connecting to a BigQuery destination.
- BinaryLogPosition = $Empty
- Use Binary log position based replication.
- CancelOperationRequest = $Empty
- The request message for Operations.CancelOperation.
- DropLargeObjects = $Empty
- Configuration to drop large object values.
- Empty = $Empty
- A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs.
- EncryptionNotEnforced = $Empty
- Message to represent the option where encryption is not enforced.
- ForwardSshTunnelConnectivity = $ForwardSshTunnelConnectivity
- Forward SSH Tunnel connectivity.
- Gtid = $Empty
- Use GTID based replication.
- Location = $Location00
- A resource that represents a Google Cloud location.
- LogFileDirectories = $LogFileDirectories
- Configuration to specify the Oracle directories to access the log files.
- LogMiner = $Empty
- Configuration to use LogMiner CDC method.
- Merge = $Empty
- Merge mode defines that all changes to a table will be merged at the destination table.
- MostRecentStartPosition = $Empty
- CDC strategy to start replicating from the most recent position in the source.
- NextAvailableStartPosition = $Empty
- CDC strategy to resume replication from the next available position in the source.
- OracleAsmLogFileAccess = $Empty
- Configuration to use Oracle ASM to access the log files.
- OracleObjectIdentifier = $ObjectIdentifier
- Oracle data source object identifier.
- PostgresqlObjectIdentifier = $ObjectIdentifier
- PostgreSQL data source object identifier.
- SqlServerChangeTables = $Empty
- Configuration to use Change Tables CDC read method.
- SqlServerObjectIdentifier = $ObjectIdentifier
- SQLServer data source object identifier.
- SqlServerTransactionLogs = $Empty
- Configuration to use Transaction Logs CDC read method.
- SrvConnectionFormat = $Empty
- Srv connection format.
- StaticServiceIpConnectivity = $Empty
- Static IP address connectivity.
- Status = $Status00
-
The
Statustype defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. - StopBackfillJobRequest = $Empty
- Request for manually stopping a running backfill job for a specific stream object.
- StreamLargeObjects = $Empty
- Configuration to stream large object values.
Exceptions / Errors
- ApiRequestError
- Represents a general error reported by the API endpoint.
- DetailedApiRequestError
- Represents a specific error reported by the API endpoint.