Module api

Source

Structs§

AppendOnly
AppendOnly mode defines that all changes to a table will be written to the destination table.
AvroFileFormat
AVRO file format configuration.
BackfillAllStrategy
Backfill strategy to automatically backfill the Stream’s objects. Specific objects can be excluded.
BackfillJob
Represents a backfill job on a specific stream object.
BackfillNoneStrategy
Backfill strategy to disable automatic backfill for the Stream’s objects.
BigQueryDestinationConfig
BigQuery destination configuration
BigQueryProfile
BigQuery warehouse profile.
CancelOperationRequest
The request message for Operations.CancelOperation.
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.
DatasetTemplate
Dataset template used for dynamic dataset creation.
Datastream
Central instance to access all Datastream related resource activities
DestinationConfig
The configuration of the stream destination.
DiscoverConnectionProfileRequest
Request message for ‘discover’ ConnectionProfile request.
DiscoverConnectionProfileResponse
Response from a discover request.
DropLargeObjects
Configuration to drop large object values.
Empty
A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
Error
Represent a user-facing Error.
FetchStaticIpsResponse
Response message for a ‘FetchStaticIps’ response.
ForwardSshTunnelConnectivity
Forward SSH Tunnel connectivity.
GcsDestinationConfig
Google Cloud Storage destination configuration
GcsProfile
Cloud Storage bucket profile.
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.
Location
A resource that represents a Google Cloud location.
LookupStreamObjectRequest
Request for looking up a specific stream object by its source object identifier.
Merge
Merge mode defines that all changes to a table will be merged at the destination table.
MostRecentStartPosition
CDC strategy to start replicating from the most recent position in the source.
MysqlColumn
MySQL Column.
MysqlDatabase
MySQL database.
MysqlLogPosition
MySQL log position
MysqlObjectIdentifier
Mysql data source object identifier.
MysqlProfile
MySQL database profile.
MysqlRdbms
MySQL database structure
MysqlSourceConfig
MySQL source configuration
MysqlSslConfig
MySQL SSL configuration information.
MysqlTable
MySQL table.
NextAvailableStartPosition
CDC strategy to resume replication from the next available position in the source.
Operation
This resource represents a long-running operation that is the result of a network API call.
OracleColumn
Oracle Column.
OracleObjectIdentifier
Oracle data source object identifier.
OracleProfile
Oracle database profile.
OracleRdbms
Oracle database structure.
OracleSchema
Oracle schema.
OracleScnPosition
Oracle SCN position
OracleSourceConfig
Oracle data source configuration
OracleSslConfig
Oracle SSL configuration information.
OracleTable
Oracle table.
PostgresqlColumn
PostgreSQL Column.
PostgresqlObjectIdentifier
PostgreSQL data source object identifier.
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
ProjectLocationConnectionProfileCreateCall
Use this method to create a connection profile in a project and location.
ProjectLocationConnectionProfileDeleteCall
Use this method to delete a connection profile.
ProjectLocationConnectionProfileDiscoverCall
Use this method to discover a connection profile. The discover API call exposes the data objects and metadata belonging to the profile. Typically, a request returns children data objects of a parent data object that’s optionally supplied in the request.
ProjectLocationConnectionProfileGetCall
Use this method to get details about a connection profile.
ProjectLocationConnectionProfileListCall
Use this method to list connection profiles created in a project and location.
ProjectLocationConnectionProfilePatchCall
Use this method to update the parameters of a connection profile.
ProjectLocationFetchStaticIpCall
The FetchStaticIps API call exposes the static IP addresses used by Datastream.
ProjectLocationGetCall
Gets information about a location.
ProjectLocationListCall
Lists information about the supported locations for this service.
ProjectLocationOperationCancelCall
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn’t support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.
ProjectLocationOperationDeleteCall
Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn’t support this method, it returns google.rpc.Code.UNIMPLEMENTED.
ProjectLocationOperationGetCall
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
ProjectLocationOperationListCall
Lists operations that match the specified filter in the request. If the server doesn’t support this method, it returns UNIMPLEMENTED.
ProjectLocationPrivateConnectionCreateCall
Use this method to create a private connectivity configuration.
ProjectLocationPrivateConnectionDeleteCall
Use this method to delete a private connectivity configuration.
ProjectLocationPrivateConnectionGetCall
Use this method to get details about a private connectivity configuration.
ProjectLocationPrivateConnectionListCall
Use this method to list private connectivity configurations in a project and location.
ProjectLocationPrivateConnectionRouteCreateCall
Use this method to create a route for a private connectivity configuration in a project and location.
ProjectLocationPrivateConnectionRouteDeleteCall
Use this method to delete a route.
ProjectLocationPrivateConnectionRouteGetCall
Use this method to get details about a route.
ProjectLocationPrivateConnectionRouteListCall
Use this method to list routes created for a private connectivity configuration in a project and location.
ProjectLocationStreamCreateCall
Use this method to create a stream.
ProjectLocationStreamDeleteCall
Use this method to delete a stream.
ProjectLocationStreamGetCall
Use this method to get details about a stream.
ProjectLocationStreamListCall
Use this method to list streams in a project and location.
ProjectLocationStreamObjectGetCall
Use this method to get details about a stream object.
ProjectLocationStreamObjectListCall
Use this method to list the objects of a specific stream.
ProjectLocationStreamObjectLookupCall
Use this method to look up a stream object by its source object identifier.
ProjectLocationStreamObjectStartBackfillJobCall
Use this method to start a backfill job for the specified stream object.
ProjectLocationStreamObjectStopBackfillJobCall
Use this method to stop a backfill job for the specified stream object.
ProjectLocationStreamPatchCall
Use this method to update the configuration of a stream.
ProjectLocationStreamRunCall
Use this method to start, resume or recover a stream with a non default CDC strategy. NOTE: This feature is currently experimental.
ProjectMethods
A builder providing access to all methods supported on project resources. It is not used directly, but through the Datastream hub.
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.
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.
SpecificStartPosition
CDC strategy to start replicating from a specific position in the source.
SqlServerChangeTables
Configuration to use Change Tables CDC read method.
SqlServerColumn
SQLServer Column.
SqlServerObjectIdentifier
SQLServer data source object identifier.
SqlServerProfile
SQLServer database profile
SqlServerRdbms
SQLServer database structure.
SqlServerSchema
SQLServer schema.
SqlServerSourceConfig
SQLServer data source configuration
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.
Status
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. 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.
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.
StreamLargeObjects
Configuration to stream large object values.
StreamObject
A specific stream object (e.g a specific DB table).
VpcPeeringConfig
The VPC Peering configuration is used to create VPC peering between Datastream and the consumer’s VPC.

Enums§

Scope
Identifies the an OAuth2 authorization scope. A scope is needed when requesting an authorization token.