Class DataMigrationServiceGrpc.DataMigrationServiceFutureStub (2.42.0)

public static final class DataMigrationServiceGrpc.DataMigrationServiceFutureStub extends AbstractFutureStub<DataMigrationServiceGrpc.DataMigrationServiceFutureStub>

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

Database Migration service

Inheritance

java.lang.Object > io.grpc.stub.AbstractStub > io.grpc.stub.AbstractFutureStub > DataMigrationServiceGrpc.DataMigrationServiceFutureStub

Methods

applyConversionWorkspace(ApplyConversionWorkspaceRequest request)

public ListenableFuture<Operation> applyConversionWorkspace(ApplyConversionWorkspaceRequest request)

Applies draft tree onto a specific destination database.

Parameter
Name Description
request ApplyConversionWorkspaceRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Operation>

build(Channel channel, CallOptions callOptions)

protected DataMigrationServiceGrpc.DataMigrationServiceFutureStub build(Channel channel, CallOptions callOptions)
Parameters
Name Description
channel io.grpc.Channel
callOptions io.grpc.CallOptions
Returns
Type Description
DataMigrationServiceGrpc.DataMigrationServiceFutureStub
Overrides
io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

commitConversionWorkspace(CommitConversionWorkspaceRequest request)

public ListenableFuture<Operation> commitConversionWorkspace(CommitConversionWorkspaceRequest request)

Marks all the data in the conversion workspace as committed.

Parameter
Name Description
request CommitConversionWorkspaceRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Operation>

convertConversionWorkspace(ConvertConversionWorkspaceRequest request)

public ListenableFuture<Operation> convertConversionWorkspace(ConvertConversionWorkspaceRequest request)

Creates a draft tree schema for the destination database.

Parameter
Name Description
request ConvertConversionWorkspaceRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Operation>

createConnectionProfile(CreateConnectionProfileRequest request)

public ListenableFuture<Operation> createConnectionProfile(CreateConnectionProfileRequest request)

Creates a new connection profile in a given project and location.

Parameter
Name Description
request CreateConnectionProfileRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Operation>

createConversionWorkspace(CreateConversionWorkspaceRequest request)

public ListenableFuture<Operation> createConversionWorkspace(CreateConversionWorkspaceRequest request)

Creates a new conversion workspace in a given project and location.

Parameter
Name Description
request CreateConversionWorkspaceRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Operation>

createMappingRule(CreateMappingRuleRequest request)

public ListenableFuture<MappingRule> createMappingRule(CreateMappingRuleRequest request)

Creates a new mapping rule for a given conversion workspace.

Parameter
Name Description
request CreateMappingRuleRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<MappingRule>

createMigrationJob(CreateMigrationJobRequest request)

public ListenableFuture<Operation> createMigrationJob(CreateMigrationJobRequest request)

Creates a new migration job in a given project and location.

Parameter
Name Description
request CreateMigrationJobRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Operation>

createPrivateConnection(CreatePrivateConnectionRequest request)

public ListenableFuture<Operation> createPrivateConnection(CreatePrivateConnectionRequest request)

Creates a new private connection in a given project and location.

Parameter
Name Description
request CreatePrivateConnectionRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Operation>

deleteConnectionProfile(DeleteConnectionProfileRequest request)

public ListenableFuture<Operation> deleteConnectionProfile(DeleteConnectionProfileRequest request)

Deletes a single Database Migration Service connection profile. A connection profile can only be deleted if it is not in use by any active migration jobs.

Parameter
Name Description
request DeleteConnectionProfileRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Operation>

deleteConversionWorkspace(DeleteConversionWorkspaceRequest request)

public ListenableFuture<Operation> deleteConversionWorkspace(DeleteConversionWorkspaceRequest request)

Deletes a single conversion workspace.

Parameter
Name Description
request DeleteConversionWorkspaceRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Operation>

deleteMappingRule(DeleteMappingRuleRequest request)

public ListenableFuture<Empty> deleteMappingRule(DeleteMappingRuleRequest request)

Deletes a single mapping rule.

Parameter
Name Description
request DeleteMappingRuleRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Empty>

deleteMigrationJob(DeleteMigrationJobRequest request)

public ListenableFuture<Operation> deleteMigrationJob(DeleteMigrationJobRequest request)

Deletes a single migration job.

Parameter
Name Description
request DeleteMigrationJobRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Operation>

deletePrivateConnection(DeletePrivateConnectionRequest request)

public ListenableFuture<Operation> deletePrivateConnection(DeletePrivateConnectionRequest request)

Deletes a single Database Migration Service private connection.

Parameter
Name Description
request DeletePrivateConnectionRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Operation>

describeConversionWorkspaceRevisions(DescribeConversionWorkspaceRevisionsRequest request)

public ListenableFuture<DescribeConversionWorkspaceRevisionsResponse> describeConversionWorkspaceRevisions(DescribeConversionWorkspaceRevisionsRequest request)

Retrieves a list of committed revisions of a specific conversion workspace.

Parameter
Name Description
request DescribeConversionWorkspaceRevisionsRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<DescribeConversionWorkspaceRevisionsResponse>

describeDatabaseEntities(DescribeDatabaseEntitiesRequest request)

public ListenableFuture<DescribeDatabaseEntitiesResponse> describeDatabaseEntities(DescribeDatabaseEntitiesRequest request)

Describes the database entities tree for a specific conversion workspace and a specific tree type. Database entities are not resources like conversion workspaces or mapping rules, and they can't be created, updated or deleted. Instead, they are simple data objects describing the structure of the client database.

Parameter
Name Description
request DescribeDatabaseEntitiesRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<DescribeDatabaseEntitiesResponse>

fetchStaticIps(FetchStaticIpsRequest request)

public ListenableFuture<FetchStaticIpsResponse> fetchStaticIps(FetchStaticIpsRequest request)

Fetches a set of static IP addresses that need to be allowlisted by the customer when using the static-IP connectivity method.

Parameter
Name Description
request FetchStaticIpsRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<FetchStaticIpsResponse>

generateSshScript(GenerateSshScriptRequest request)

public ListenableFuture<SshScript> generateSshScript(GenerateSshScriptRequest request)

Generate a SSH configuration script to configure the reverse SSH connectivity.

Parameter
Name Description
request GenerateSshScriptRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<SshScript>

generateTcpProxyScript(GenerateTcpProxyScriptRequest request)

public ListenableFuture<TcpProxyScript> generateTcpProxyScript(GenerateTcpProxyScriptRequest request)

Generate a TCP Proxy configuration script to configure a cloud-hosted VM running a TCP Proxy.

Parameter
Name Description
request GenerateTcpProxyScriptRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<TcpProxyScript>

getConnectionProfile(GetConnectionProfileRequest request)

public ListenableFuture<ConnectionProfile> getConnectionProfile(GetConnectionProfileRequest request)

Gets details of a single connection profile.

Parameter
Name Description
request GetConnectionProfileRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<ConnectionProfile>

getConversionWorkspace(GetConversionWorkspaceRequest request)

public ListenableFuture<ConversionWorkspace> getConversionWorkspace(GetConversionWorkspaceRequest request)

Gets details of a single conversion workspace.

Parameter
Name Description
request GetConversionWorkspaceRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<ConversionWorkspace>

getMappingRule(GetMappingRuleRequest request)

public ListenableFuture<MappingRule> getMappingRule(GetMappingRuleRequest request)

Gets the details of a mapping rule.

Parameter
Name Description
request GetMappingRuleRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<MappingRule>

getMigrationJob(GetMigrationJobRequest request)

public ListenableFuture<MigrationJob> getMigrationJob(GetMigrationJobRequest request)

Gets details of a single migration job.

Parameter
Name Description
request GetMigrationJobRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<MigrationJob>

getPrivateConnection(GetPrivateConnectionRequest request)

public ListenableFuture<PrivateConnection> getPrivateConnection(GetPrivateConnectionRequest request)

Gets details of a single private connection.

Parameter
Name Description
request GetPrivateConnectionRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<PrivateConnection>

importMappingRules(ImportMappingRulesRequest request)

public ListenableFuture<Operation> importMappingRules(ImportMappingRulesRequest request)

Imports the mapping rules for a given conversion workspace. Supports various formats of external rules files.

Parameter
Name Description
request ImportMappingRulesRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Operation>

listConnectionProfiles(ListConnectionProfilesRequest request)

public ListenableFuture<ListConnectionProfilesResponse> listConnectionProfiles(ListConnectionProfilesRequest request)

Retrieves a list of all connection profiles in a given project and location.

Parameter
Name Description
request ListConnectionProfilesRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<ListConnectionProfilesResponse>

listConversionWorkspaces(ListConversionWorkspacesRequest request)

public ListenableFuture<ListConversionWorkspacesResponse> listConversionWorkspaces(ListConversionWorkspacesRequest request)

Lists conversion workspaces in a given project and location.

Parameter
Name Description
request ListConversionWorkspacesRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<ListConversionWorkspacesResponse>

listMappingRules(ListMappingRulesRequest request)

public ListenableFuture<ListMappingRulesResponse> listMappingRules(ListMappingRulesRequest request)

Lists the mapping rules for a specific conversion workspace.

Parameter
Name Description
request ListMappingRulesRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<ListMappingRulesResponse>

listMigrationJobs(ListMigrationJobsRequest request)

public ListenableFuture<ListMigrationJobsResponse> listMigrationJobs(ListMigrationJobsRequest request)

Lists migration jobs in a given project and location.

Parameter
Name Description
request ListMigrationJobsRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<ListMigrationJobsResponse>

listPrivateConnections(ListPrivateConnectionsRequest request)

public ListenableFuture<ListPrivateConnectionsResponse> listPrivateConnections(ListPrivateConnectionsRequest request)

Retrieves a list of private connections in a given project and location.

Parameter
Name Description
request ListPrivateConnectionsRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<ListPrivateConnectionsResponse>

promoteMigrationJob(PromoteMigrationJobRequest request)

public ListenableFuture<Operation> promoteMigrationJob(PromoteMigrationJobRequest request)

Promote a migration job, stopping replication to the destination and promoting the destination to be a standalone database.

Parameter
Name Description
request PromoteMigrationJobRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Operation>

restartMigrationJob(RestartMigrationJobRequest request)

public ListenableFuture<Operation> restartMigrationJob(RestartMigrationJobRequest request)

Restart a stopped or failed migration job, resetting the destination instance to its original state and starting the migration process from scratch.

Parameter
Name Description
request RestartMigrationJobRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Operation>

resumeMigrationJob(ResumeMigrationJobRequest request)

public ListenableFuture<Operation> resumeMigrationJob(ResumeMigrationJobRequest request)

Resume a migration job that is currently stopped and is resumable (was stopped during CDC phase).

Parameter
Name Description
request ResumeMigrationJobRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Operation>

rollbackConversionWorkspace(RollbackConversionWorkspaceRequest request)

public ListenableFuture<Operation> rollbackConversionWorkspace(RollbackConversionWorkspaceRequest request)

Rolls back a conversion workspace to the last committed snapshot.

Parameter
Name Description
request RollbackConversionWorkspaceRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Operation>

searchBackgroundJobs(SearchBackgroundJobsRequest request)

public ListenableFuture<SearchBackgroundJobsResponse> searchBackgroundJobs(SearchBackgroundJobsRequest request)

Searches/lists the background jobs for a specific conversion workspace. The background jobs are not resources like conversion workspaces or mapping rules, and they can't be created, updated or deleted. Instead, they are a way to expose the data plane jobs log.

Parameter
Name Description
request SearchBackgroundJobsRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<SearchBackgroundJobsResponse>

seedConversionWorkspace(SeedConversionWorkspaceRequest request)

public ListenableFuture<Operation> seedConversionWorkspace(SeedConversionWorkspaceRequest request)

Imports a snapshot of the source database into the conversion workspace.

Parameter
Name Description
request SeedConversionWorkspaceRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Operation>

startMigrationJob(StartMigrationJobRequest request)

public ListenableFuture<Operation> startMigrationJob(StartMigrationJobRequest request)

Start an already created migration job.

Parameter
Name Description
request StartMigrationJobRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Operation>

stopMigrationJob(StopMigrationJobRequest request)

public ListenableFuture<Operation> stopMigrationJob(StopMigrationJobRequest request)

Stops a running migration job.

Parameter
Name Description
request StopMigrationJobRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Operation>

updateConnectionProfile(UpdateConnectionProfileRequest request)

public ListenableFuture<Operation> updateConnectionProfile(UpdateConnectionProfileRequest request)

Update the configuration of a single connection profile.

Parameter
Name Description
request UpdateConnectionProfileRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Operation>

updateConversionWorkspace(UpdateConversionWorkspaceRequest request)

public ListenableFuture<Operation> updateConversionWorkspace(UpdateConversionWorkspaceRequest request)

Updates the parameters of a single conversion workspace.

Parameter
Name Description
request UpdateConversionWorkspaceRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Operation>

updateMigrationJob(UpdateMigrationJobRequest request)

public ListenableFuture<Operation> updateMigrationJob(UpdateMigrationJobRequest request)

Updates the parameters of a single migration job.

Parameter
Name Description
request UpdateMigrationJobRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Operation>

verifyMigrationJob(VerifyMigrationJobRequest request)

public ListenableFuture<Operation> verifyMigrationJob(VerifyMigrationJobRequest request)

Verify a migration job, making sure the destination can reach the source and that all configuration and prerequisites are met.

Parameter
Name Description
request VerifyMigrationJobRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Operation>