Package com.google.cloud.datastream.v1alpha1 (1.27.0)

A client to Datastream API

The interfaces provided are listed below, along with usage samples.

DatastreamClient

Service Description: Datastream service

Sample for DatastreamClient:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DatastreamClient datastreamClient = DatastreamClient.create()) {
   ConnectionProfileName name =
       ConnectionProfileName.of("[PROJECT]", "[LOCATION]", "[CONNECTION_PROFILE]");
   ConnectionProfile response = datastreamClient.getConnectionProfile(name);
 }

Classes

AvroFileFormat

AVRO file format configuration.

Protobuf type google.cloud.datastream.v1alpha1.AvroFileFormat

AvroFileFormat.Builder

AVRO file format configuration.

Protobuf type google.cloud.datastream.v1alpha1.AvroFileFormat

ConnectionProfile

Protobuf type google.cloud.datastream.v1alpha1.ConnectionProfile

ConnectionProfile.Builder

Protobuf type google.cloud.datastream.v1alpha1.ConnectionProfile

ConnectionProfileName.Builder

Builder for projects/{project}/locations/{location}/connectionProfiles/{connection_profile}.

CreateConnectionProfileRequest

Protobuf type google.cloud.datastream.v1alpha1.CreateConnectionProfileRequest

CreateConnectionProfileRequest.Builder

Protobuf type google.cloud.datastream.v1alpha1.CreateConnectionProfileRequest

CreatePrivateConnectionRequest

Protobuf type google.cloud.datastream.v1alpha1.CreatePrivateConnectionRequest

CreatePrivateConnectionRequest.Builder

Protobuf type google.cloud.datastream.v1alpha1.CreatePrivateConnectionRequest

CreateRouteRequest

route creation request

Protobuf type google.cloud.datastream.v1alpha1.CreateRouteRequest

CreateRouteRequest.Builder

route creation request

Protobuf type google.cloud.datastream.v1alpha1.CreateRouteRequest

CreateStreamRequest

Protobuf type google.cloud.datastream.v1alpha1.CreateStreamRequest

CreateStreamRequest.Builder

Protobuf type google.cloud.datastream.v1alpha1.CreateStreamRequest

DatastreamClient

Service Description: Datastream service

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DatastreamClient datastreamClient = DatastreamClient.create()) {
   ConnectionProfileName name =
       ConnectionProfileName.of("[PROJECT]", "[LOCATION]", "[CONNECTION_PROFILE]");
   ConnectionProfile response = datastreamClient.getConnectionProfile(name);
 }

Note: close() needs to be called on the DatastreamClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

The surface of this class includes several types of Java methods for each of the API's methods:

A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

See the individual methods for example code.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.

This class can be customized by passing in a custom instance of DatastreamSettings to create(). For example:

To customize credentials:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 DatastreamSettings datastreamSettings =
     DatastreamSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 DatastreamClient datastreamClient = DatastreamClient.create(datastreamSettings);

To customize the endpoint:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 DatastreamSettings datastreamSettings =
     DatastreamSettings.newBuilder().setEndpoint(myEndpoint).build();
 DatastreamClient datastreamClient = DatastreamClient.create(datastreamSettings);

To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 DatastreamSettings datastreamSettings = DatastreamSettings.newHttpJsonBuilder().build();
 DatastreamClient datastreamClient = DatastreamClient.create(datastreamSettings);

Please refer to the GitHub repository's samples for more quickstart code snippets.

DatastreamClient.FetchStaticIpsFixedSizeCollection

DatastreamClient.FetchStaticIpsPage

DatastreamClient.FetchStaticIpsPagedResponse

DatastreamClient.ListConnectionProfilesFixedSizeCollection

DatastreamClient.ListConnectionProfilesPage

DatastreamClient.ListConnectionProfilesPagedResponse

DatastreamClient.ListPrivateConnectionsFixedSizeCollection

DatastreamClient.ListPrivateConnectionsPage

DatastreamClient.ListPrivateConnectionsPagedResponse

DatastreamClient.ListRoutesFixedSizeCollection

DatastreamClient.ListRoutesPage

DatastreamClient.ListRoutesPagedResponse

DatastreamClient.ListStreamsFixedSizeCollection

DatastreamClient.ListStreamsPage

DatastreamClient.ListStreamsPagedResponse

DatastreamGrpc

Datastream service

DatastreamGrpc.DatastreamBlockingStub

A stub to allow clients to do synchronous rpc calls to service Datastream.

Datastream service

DatastreamGrpc.DatastreamFutureStub

A stub to allow clients to do ListenableFuture-style rpc calls to service Datastream.

Datastream service

DatastreamGrpc.DatastreamImplBase

Base class for the server implementation of the service Datastream.

Datastream service

DatastreamGrpc.DatastreamStub

A stub to allow clients to do asynchronous rpc calls to service Datastream.

Datastream service

DatastreamSettings

Settings class to configure an instance of DatastreamClient.

The default instance has everything set to sensible defaults:

The default service address (datastream.googleapis.com) and default port (443) are used.
Credentials are acquired automatically through Application Default Credentials.
Retries are configured for idempotent methods but not for non-idempotent methods.

The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.

For example, to set the total timeout of getConnectionProfile to 30 seconds:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 DatastreamSettings.Builder datastreamSettingsBuilder = DatastreamSettings.newBuilder();
 datastreamSettingsBuilder
     .getConnectionProfileSettings()
     .setRetrySettings(
         datastreamSettingsBuilder
             .getConnectionProfileSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 DatastreamSettings datastreamSettings = datastreamSettingsBuilder.build();

DatastreamSettings.Builder

Builder for DatastreamSettings.

DeleteConnectionProfileRequest

Protobuf type google.cloud.datastream.v1alpha1.DeleteConnectionProfileRequest

DeleteConnectionProfileRequest.Builder

Protobuf type google.cloud.datastream.v1alpha1.DeleteConnectionProfileRequest

DeletePrivateConnectionRequest

Protobuf type google.cloud.datastream.v1alpha1.DeletePrivateConnectionRequest

DeletePrivateConnectionRequest.Builder

Protobuf type google.cloud.datastream.v1alpha1.DeletePrivateConnectionRequest

DeleteRouteRequest

route deletion request

Protobuf type google.cloud.datastream.v1alpha1.DeleteRouteRequest

DeleteRouteRequest.Builder

route deletion request

Protobuf type google.cloud.datastream.v1alpha1.DeleteRouteRequest

DeleteStreamRequest

Protobuf type google.cloud.datastream.v1alpha1.DeleteStreamRequest

DeleteStreamRequest.Builder

Protobuf type google.cloud.datastream.v1alpha1.DeleteStreamRequest

DestinationConfig

The configuration of the stream destination.

Protobuf type google.cloud.datastream.v1alpha1.DestinationConfig

DestinationConfig.Builder

The configuration of the stream destination.

Protobuf type google.cloud.datastream.v1alpha1.DestinationConfig

DiscoverConnectionProfileRequest

Request message for 'discover' ConnectionProfile request.

Protobuf type google.cloud.datastream.v1alpha1.DiscoverConnectionProfileRequest

DiscoverConnectionProfileRequest.Builder

Request message for 'discover' ConnectionProfile request.

Protobuf type google.cloud.datastream.v1alpha1.DiscoverConnectionProfileRequest

DiscoverConnectionProfileResponse

Protobuf type google.cloud.datastream.v1alpha1.DiscoverConnectionProfileResponse

DiscoverConnectionProfileResponse.Builder

Protobuf type google.cloud.datastream.v1alpha1.DiscoverConnectionProfileResponse

Error

Represent a user-facing Error.

Protobuf type google.cloud.datastream.v1alpha1.Error

Error.Builder

Represent a user-facing Error.

Protobuf type google.cloud.datastream.v1alpha1.Error

FetchErrorsRequest

Request message for 'FetchErrors' request.

Protobuf type google.cloud.datastream.v1alpha1.FetchErrorsRequest

FetchErrorsRequest.Builder

Request message for 'FetchErrors' request.

Protobuf type google.cloud.datastream.v1alpha1.FetchErrorsRequest

FetchErrorsResponse

Response message for a 'FetchErrors' response.

Protobuf type google.cloud.datastream.v1alpha1.FetchErrorsResponse

FetchErrorsResponse.Builder

Response message for a 'FetchErrors' response.

Protobuf type google.cloud.datastream.v1alpha1.FetchErrorsResponse

FetchStaticIpsRequest

Request message for 'FetchStaticIps' request.

Protobuf type google.cloud.datastream.v1alpha1.FetchStaticIpsRequest

FetchStaticIpsRequest.Builder

Request message for 'FetchStaticIps' request.

Protobuf type google.cloud.datastream.v1alpha1.FetchStaticIpsRequest

FetchStaticIpsResponse

Response message for a 'FetchStaticIps' response.

Protobuf type google.cloud.datastream.v1alpha1.FetchStaticIpsResponse

FetchStaticIpsResponse.Builder

Response message for a 'FetchStaticIps' response.

Protobuf type google.cloud.datastream.v1alpha1.FetchStaticIpsResponse

ForwardSshTunnelConnectivity

Forward SSH Tunnel connectivity.

Protobuf type google.cloud.datastream.v1alpha1.ForwardSshTunnelConnectivity

ForwardSshTunnelConnectivity.Builder

Forward SSH Tunnel connectivity.

Protobuf type google.cloud.datastream.v1alpha1.ForwardSshTunnelConnectivity

GcsDestinationConfig

Google Cloud Storage destination configuration

Protobuf type google.cloud.datastream.v1alpha1.GcsDestinationConfig

GcsDestinationConfig.Builder

Google Cloud Storage destination configuration

Protobuf type google.cloud.datastream.v1alpha1.GcsDestinationConfig

GcsProfile

Cloud Storage bucket profile.

Protobuf type google.cloud.datastream.v1alpha1.GcsProfile

GcsProfile.Builder

Cloud Storage bucket profile.

Protobuf type google.cloud.datastream.v1alpha1.GcsProfile

GetConnectionProfileRequest

Protobuf type google.cloud.datastream.v1alpha1.GetConnectionProfileRequest

GetConnectionProfileRequest.Builder

Protobuf type google.cloud.datastream.v1alpha1.GetConnectionProfileRequest

GetPrivateConnectionRequest

Protobuf type google.cloud.datastream.v1alpha1.GetPrivateConnectionRequest

GetPrivateConnectionRequest.Builder

Protobuf type google.cloud.datastream.v1alpha1.GetPrivateConnectionRequest

GetRouteRequest

route get request

Protobuf type google.cloud.datastream.v1alpha1.GetRouteRequest

GetRouteRequest.Builder

route get request

Protobuf type google.cloud.datastream.v1alpha1.GetRouteRequest

GetStreamRequest

Protobuf type google.cloud.datastream.v1alpha1.GetStreamRequest

GetStreamRequest.Builder

Protobuf type google.cloud.datastream.v1alpha1.GetStreamRequest

JsonFileFormat

JSON file format configuration.

Protobuf type google.cloud.datastream.v1alpha1.JsonFileFormat

JsonFileFormat.Builder

JSON file format configuration.

Protobuf type google.cloud.datastream.v1alpha1.JsonFileFormat

ListConnectionProfilesRequest

Protobuf type google.cloud.datastream.v1alpha1.ListConnectionProfilesRequest

ListConnectionProfilesRequest.Builder

Protobuf type google.cloud.datastream.v1alpha1.ListConnectionProfilesRequest

ListConnectionProfilesResponse

Protobuf type google.cloud.datastream.v1alpha1.ListConnectionProfilesResponse

ListConnectionProfilesResponse.Builder

Protobuf type google.cloud.datastream.v1alpha1.ListConnectionProfilesResponse

ListPrivateConnectionsRequest

Protobuf type google.cloud.datastream.v1alpha1.ListPrivateConnectionsRequest

ListPrivateConnectionsRequest.Builder

Protobuf type google.cloud.datastream.v1alpha1.ListPrivateConnectionsRequest

ListPrivateConnectionsResponse

Protobuf type google.cloud.datastream.v1alpha1.ListPrivateConnectionsResponse

ListPrivateConnectionsResponse.Builder

Protobuf type google.cloud.datastream.v1alpha1.ListPrivateConnectionsResponse

ListRoutesRequest

route list request

Protobuf type google.cloud.datastream.v1alpha1.ListRoutesRequest

ListRoutesRequest.Builder

route list request

Protobuf type google.cloud.datastream.v1alpha1.ListRoutesRequest

ListRoutesResponse

route list response

Protobuf type google.cloud.datastream.v1alpha1.ListRoutesResponse

ListRoutesResponse.Builder

route list response

Protobuf type google.cloud.datastream.v1alpha1.ListRoutesResponse

ListStreamsRequest

Protobuf type google.cloud.datastream.v1alpha1.ListStreamsRequest

ListStreamsRequest.Builder

Protobuf type google.cloud.datastream.v1alpha1.ListStreamsRequest

ListStreamsResponse

Protobuf type google.cloud.datastream.v1alpha1.ListStreamsResponse

ListStreamsResponse.Builder

Protobuf type google.cloud.datastream.v1alpha1.ListStreamsResponse

LocationName

LocationName.Builder

Builder for projects/{project}/locations/{location}.

MysqlColumn

MySQL Column.

Protobuf type google.cloud.datastream.v1alpha1.MysqlColumn

MysqlColumn.Builder

MySQL Column.

Protobuf type google.cloud.datastream.v1alpha1.MysqlColumn

MysqlDatabase

MySQL database.

Protobuf type google.cloud.datastream.v1alpha1.MysqlDatabase

MysqlDatabase.Builder

MySQL database.

Protobuf type google.cloud.datastream.v1alpha1.MysqlDatabase

MysqlProfile

MySQL database profile.

Protobuf type google.cloud.datastream.v1alpha1.MysqlProfile

MysqlProfile.Builder

MySQL database profile.

Protobuf type google.cloud.datastream.v1alpha1.MysqlProfile

MysqlRdbms

MySQL database structure

Protobuf type google.cloud.datastream.v1alpha1.MysqlRdbms

MysqlRdbms.Builder

MySQL database structure

Protobuf type google.cloud.datastream.v1alpha1.MysqlRdbms

MysqlSourceConfig

MySQL source configuration

Protobuf type google.cloud.datastream.v1alpha1.MysqlSourceConfig

MysqlSourceConfig.Builder

MySQL source configuration

Protobuf type google.cloud.datastream.v1alpha1.MysqlSourceConfig

MysqlSslConfig

MySQL SSL configuration information.

Protobuf type google.cloud.datastream.v1alpha1.MysqlSslConfig

MysqlSslConfig.Builder

MySQL SSL configuration information.

Protobuf type google.cloud.datastream.v1alpha1.MysqlSslConfig

MysqlTable

MySQL table.

Protobuf type google.cloud.datastream.v1alpha1.MysqlTable

MysqlTable.Builder

MySQL table.

Protobuf type google.cloud.datastream.v1alpha1.MysqlTable

NoConnectivitySettings

No connectivity settings.

Protobuf type google.cloud.datastream.v1alpha1.NoConnectivitySettings

NoConnectivitySettings.Builder

No connectivity settings.

Protobuf type google.cloud.datastream.v1alpha1.NoConnectivitySettings

OperationMetadata

Represents the metadata of the long-running operation.

Protobuf type google.cloud.datastream.v1alpha1.OperationMetadata

OperationMetadata.Builder

Represents the metadata of the long-running operation.

Protobuf type google.cloud.datastream.v1alpha1.OperationMetadata

OracleColumn

Oracle Column.

Protobuf type google.cloud.datastream.v1alpha1.OracleColumn

OracleColumn.Builder

Oracle Column.

Protobuf type google.cloud.datastream.v1alpha1.OracleColumn

OracleProfile

Oracle database profile.

Protobuf type google.cloud.datastream.v1alpha1.OracleProfile

OracleProfile.Builder

Oracle database profile.

Protobuf type google.cloud.datastream.v1alpha1.OracleProfile

OracleRdbms

Oracle database structure.

Protobuf type google.cloud.datastream.v1alpha1.OracleRdbms

OracleRdbms.Builder

Oracle database structure.

Protobuf type google.cloud.datastream.v1alpha1.OracleRdbms

OracleSchema

Oracle schema.

Protobuf type google.cloud.datastream.v1alpha1.OracleSchema

OracleSchema.Builder

Oracle schema.

Protobuf type google.cloud.datastream.v1alpha1.OracleSchema

OracleSourceConfig

Oracle data source configuration

Protobuf type google.cloud.datastream.v1alpha1.OracleSourceConfig

OracleSourceConfig.Builder

Oracle data source configuration

Protobuf type google.cloud.datastream.v1alpha1.OracleSourceConfig

OracleTable

Oracle table.

Protobuf type google.cloud.datastream.v1alpha1.OracleTable

OracleTable.Builder

Oracle table.

Protobuf type google.cloud.datastream.v1alpha1.OracleTable

PrivateConnection

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

Protobuf type google.cloud.datastream.v1alpha1.PrivateConnection

PrivateConnection.Builder

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

Protobuf type google.cloud.datastream.v1alpha1.PrivateConnection

PrivateConnectionName

PrivateConnectionName.Builder

Builder for projects/{project}/locations/{location}/privateConnections/{private_connection}.

PrivateConnectivity

Private Connectivity

Protobuf type google.cloud.datastream.v1alpha1.PrivateConnectivity

PrivateConnectivity.Builder

Private Connectivity

Protobuf type google.cloud.datastream.v1alpha1.PrivateConnectivity

Route

The Route resource is the child of the PrivateConnection resource. It used to define a route for a PrivateConnection setup.

Protobuf type google.cloud.datastream.v1alpha1.Route

Route.Builder

The Route resource is the child of the PrivateConnection resource. It used to define a route for a PrivateConnection setup.

Protobuf type google.cloud.datastream.v1alpha1.Route

RouteName

RouteName.Builder

Builder for projects/{project}/locations/{location}/privateConnections/{private_connection}/routes/{route}.

SourceConfig

The configuration of the stream source.

Protobuf type google.cloud.datastream.v1alpha1.SourceConfig

SourceConfig.Builder

The configuration of the stream source.

Protobuf type google.cloud.datastream.v1alpha1.SourceConfig

StaticServiceIpConnectivity

Static IP address connectivity.

Protobuf type google.cloud.datastream.v1alpha1.StaticServiceIpConnectivity

StaticServiceIpConnectivity.Builder

Static IP address connectivity.

Protobuf type google.cloud.datastream.v1alpha1.StaticServiceIpConnectivity

Stream

Protobuf type google.cloud.datastream.v1alpha1.Stream

Stream.BackfillAllStrategy

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

Protobuf type google.cloud.datastream.v1alpha1.Stream.BackfillAllStrategy

Stream.BackfillAllStrategy.Builder

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

Protobuf type google.cloud.datastream.v1alpha1.Stream.BackfillAllStrategy

Stream.BackfillNoneStrategy

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

Protobuf type google.cloud.datastream.v1alpha1.Stream.BackfillNoneStrategy

Stream.BackfillNoneStrategy.Builder

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

Protobuf type google.cloud.datastream.v1alpha1.Stream.BackfillNoneStrategy

Stream.Builder

Protobuf type google.cloud.datastream.v1alpha1.Stream

StreamName

StreamName.Builder

Builder for projects/{project}/locations/{location}/streams/{stream}.

UpdateConnectionProfileRequest

Protobuf type google.cloud.datastream.v1alpha1.UpdateConnectionProfileRequest

UpdateConnectionProfileRequest.Builder

Protobuf type google.cloud.datastream.v1alpha1.UpdateConnectionProfileRequest

UpdateStreamRequest

Protobuf type google.cloud.datastream.v1alpha1.UpdateStreamRequest

UpdateStreamRequest.Builder

Protobuf type google.cloud.datastream.v1alpha1.UpdateStreamRequest

Validation

Protobuf type google.cloud.datastream.v1alpha1.Validation

Validation.Builder

Protobuf type google.cloud.datastream.v1alpha1.Validation

ValidationMessage

Represent user-facing validation result message.

Protobuf type google.cloud.datastream.v1alpha1.ValidationMessage

ValidationMessage.Builder

Represent user-facing validation result message.

Protobuf type google.cloud.datastream.v1alpha1.ValidationMessage

ValidationResult

Contains the current validation results.

Protobuf type google.cloud.datastream.v1alpha1.ValidationResult

ValidationResult.Builder

Contains the current validation results.

Protobuf type google.cloud.datastream.v1alpha1.ValidationResult

VpcPeeringConfig

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

Protobuf type google.cloud.datastream.v1alpha1.VpcPeeringConfig

VpcPeeringConfig.Builder

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

Protobuf type google.cloud.datastream.v1alpha1.VpcPeeringConfig