Interface DataMigrationServiceGrpc.AsyncService (2.52.0)

public static interface DataMigrationServiceGrpc.AsyncService

Database Migration service

Methods

applyConversionWorkspace(ApplyConversionWorkspaceRequest request, StreamObserver<Operation> responseObserver)

public default void applyConversionWorkspace(ApplyConversionWorkspaceRequest request, StreamObserver<Operation> responseObserver)

Applies draft tree onto a specific destination database.

Parameters
Name	Description
`request`	`ApplyConversionWorkspaceRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<Operation>`

commitConversionWorkspace(CommitConversionWorkspaceRequest request, StreamObserver<Operation> responseObserver)

public default void commitConversionWorkspace(CommitConversionWorkspaceRequest request, StreamObserver<Operation> responseObserver)

Marks all the data in the conversion workspace as committed.

Parameters
Name	Description
`request`	`CommitConversionWorkspaceRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<Operation>`

convertConversionWorkspace(ConvertConversionWorkspaceRequest request, StreamObserver<Operation> responseObserver)

public default void convertConversionWorkspace(ConvertConversionWorkspaceRequest request, StreamObserver<Operation> responseObserver)

Creates a draft tree schema for the destination database.

Parameters
Name	Description
`request`	`ConvertConversionWorkspaceRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<Operation>`

createConnectionProfile(CreateConnectionProfileRequest request, StreamObserver<Operation> responseObserver)

public default void createConnectionProfile(CreateConnectionProfileRequest request, StreamObserver<Operation> responseObserver)

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

Parameters
Name	Description
`request`	`CreateConnectionProfileRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<Operation>`

createConversionWorkspace(CreateConversionWorkspaceRequest request, StreamObserver<Operation> responseObserver)

public default void createConversionWorkspace(CreateConversionWorkspaceRequest request, StreamObserver<Operation> responseObserver)

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

Parameters
Name	Description
`request`	`CreateConversionWorkspaceRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<Operation>`

createMappingRule(CreateMappingRuleRequest request, StreamObserver<MappingRule> responseObserver)

public default void createMappingRule(CreateMappingRuleRequest request, StreamObserver<MappingRule> responseObserver)

Creates a new mapping rule for a given conversion workspace.

Parameters
Name	Description
`request`	`CreateMappingRuleRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<MappingRule>`

createMigrationJob(CreateMigrationJobRequest request, StreamObserver<Operation> responseObserver)

public default void createMigrationJob(CreateMigrationJobRequest request, StreamObserver<Operation> responseObserver)

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

Parameters
Name	Description
`request`	`CreateMigrationJobRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<Operation>`

createPrivateConnection(CreatePrivateConnectionRequest request, StreamObserver<Operation> responseObserver)

public default void createPrivateConnection(CreatePrivateConnectionRequest request, StreamObserver<Operation> responseObserver)

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

Parameters
Name	Description
`request`	`CreatePrivateConnectionRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<Operation>`

deleteConnectionProfile(DeleteConnectionProfileRequest request, StreamObserver<Operation> responseObserver)

public default void deleteConnectionProfile(DeleteConnectionProfileRequest request, StreamObserver<Operation> responseObserver)

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.

Parameters
Name	Description
`request`	`DeleteConnectionProfileRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<Operation>`

deleteConversionWorkspace(DeleteConversionWorkspaceRequest request, StreamObserver<Operation> responseObserver)

public default void deleteConversionWorkspace(DeleteConversionWorkspaceRequest request, StreamObserver<Operation> responseObserver)

Deletes a single conversion workspace.

Parameters
Name	Description
`request`	`DeleteConversionWorkspaceRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<Operation>`

deleteMappingRule(DeleteMappingRuleRequest request, StreamObserver<Empty> responseObserver)

public default void deleteMappingRule(DeleteMappingRuleRequest request, StreamObserver<Empty> responseObserver)

Deletes a single mapping rule.

Parameters
Name	Description
`request`	`DeleteMappingRuleRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<Empty>`

deleteMigrationJob(DeleteMigrationJobRequest request, StreamObserver<Operation> responseObserver)

public default void deleteMigrationJob(DeleteMigrationJobRequest request, StreamObserver<Operation> responseObserver)

Deletes a single migration job.

Parameters
Name	Description
`request`	`DeleteMigrationJobRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<Operation>`

deletePrivateConnection(DeletePrivateConnectionRequest request, StreamObserver<Operation> responseObserver)

public default void deletePrivateConnection(DeletePrivateConnectionRequest request, StreamObserver<Operation> responseObserver)

Deletes a single Database Migration Service private connection.

Parameters
Name	Description
`request`	`DeletePrivateConnectionRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<Operation>`

describeConversionWorkspaceRevisions(DescribeConversionWorkspaceRevisionsRequest request, StreamObserver<DescribeConversionWorkspaceRevisionsResponse> responseObserver)

public default void describeConversionWorkspaceRevisions(DescribeConversionWorkspaceRevisionsRequest request, StreamObserver<DescribeConversionWorkspaceRevisionsResponse> responseObserver)

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

Parameters
Name	Description
`request`	`DescribeConversionWorkspaceRevisionsRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<DescribeConversionWorkspaceRevisionsResponse>`

describeDatabaseEntities(DescribeDatabaseEntitiesRequest request, StreamObserver<DescribeDatabaseEntitiesResponse> responseObserver)

public default void describeDatabaseEntities(DescribeDatabaseEntitiesRequest request, StreamObserver<DescribeDatabaseEntitiesResponse> responseObserver)

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.

Parameters
Name	Description
`request`	`DescribeDatabaseEntitiesRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<DescribeDatabaseEntitiesResponse>`

fetchStaticIps(FetchStaticIpsRequest request, StreamObserver<FetchStaticIpsResponse> responseObserver)

public default void fetchStaticIps(FetchStaticIpsRequest request, StreamObserver<FetchStaticIpsResponse> responseObserver)

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

Parameters
Name	Description
`request`	`FetchStaticIpsRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<FetchStaticIpsResponse>`

generateSshScript(GenerateSshScriptRequest request, StreamObserver<SshScript> responseObserver)

public default void generateSshScript(GenerateSshScriptRequest request, StreamObserver<SshScript> responseObserver)

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

Parameters
Name	Description
`request`	`GenerateSshScriptRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<SshScript>`

generateTcpProxyScript(GenerateTcpProxyScriptRequest request, StreamObserver<TcpProxyScript> responseObserver)

public default void generateTcpProxyScript(GenerateTcpProxyScriptRequest request, StreamObserver<TcpProxyScript> responseObserver)

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

Parameters
Name	Description
`request`	`GenerateTcpProxyScriptRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<TcpProxyScript>`

getConnectionProfile(GetConnectionProfileRequest request, StreamObserver<ConnectionProfile> responseObserver)

public default void getConnectionProfile(GetConnectionProfileRequest request, StreamObserver<ConnectionProfile> responseObserver)

Gets details of a single connection profile.

Parameters
Name	Description
`request`	`GetConnectionProfileRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<ConnectionProfile>`

getConversionWorkspace(GetConversionWorkspaceRequest request, StreamObserver<ConversionWorkspace> responseObserver)

public default void getConversionWorkspace(GetConversionWorkspaceRequest request, StreamObserver<ConversionWorkspace> responseObserver)

Gets details of a single conversion workspace.

Parameters
Name	Description
`request`	`GetConversionWorkspaceRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<ConversionWorkspace>`

getMappingRule(GetMappingRuleRequest request, StreamObserver<MappingRule> responseObserver)

public default void getMappingRule(GetMappingRuleRequest request, StreamObserver<MappingRule> responseObserver)

Gets the details of a mapping rule.

Parameters
Name	Description
`request`	`GetMappingRuleRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<MappingRule>`

getMigrationJob(GetMigrationJobRequest request, StreamObserver<MigrationJob> responseObserver)

public default void getMigrationJob(GetMigrationJobRequest request, StreamObserver<MigrationJob> responseObserver)

Gets details of a single migration job.

Parameters
Name	Description
`request`	`GetMigrationJobRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<MigrationJob>`

getPrivateConnection(GetPrivateConnectionRequest request, StreamObserver<PrivateConnection> responseObserver)

public default void getPrivateConnection(GetPrivateConnectionRequest request, StreamObserver<PrivateConnection> responseObserver)

Gets details of a single private connection.

Parameters
Name	Description
`request`	`GetPrivateConnectionRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<PrivateConnection>`

importMappingRules(ImportMappingRulesRequest request, StreamObserver<Operation> responseObserver)

public default void importMappingRules(ImportMappingRulesRequest request, StreamObserver<Operation> responseObserver)

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

Parameters
Name	Description
`request`	`ImportMappingRulesRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<Operation>`

listConnectionProfiles(ListConnectionProfilesRequest request, StreamObserver<ListConnectionProfilesResponse> responseObserver)

public default void listConnectionProfiles(ListConnectionProfilesRequest request, StreamObserver<ListConnectionProfilesResponse> responseObserver)

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

Parameters
Name	Description
`request`	`ListConnectionProfilesRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<ListConnectionProfilesResponse>`

listConversionWorkspaces(ListConversionWorkspacesRequest request, StreamObserver<ListConversionWorkspacesResponse> responseObserver)

public default void listConversionWorkspaces(ListConversionWorkspacesRequest request, StreamObserver<ListConversionWorkspacesResponse> responseObserver)

Lists conversion workspaces in a given project and location.

Parameters
Name	Description
`request`	`ListConversionWorkspacesRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<ListConversionWorkspacesResponse>`

listMappingRules(ListMappingRulesRequest request, StreamObserver<ListMappingRulesResponse> responseObserver)

public default void listMappingRules(ListMappingRulesRequest request, StreamObserver<ListMappingRulesResponse> responseObserver)

Lists the mapping rules for a specific conversion workspace.

Parameters
Name	Description
`request`	`ListMappingRulesRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<ListMappingRulesResponse>`

listMigrationJobs(ListMigrationJobsRequest request, StreamObserver<ListMigrationJobsResponse> responseObserver)

public default void listMigrationJobs(ListMigrationJobsRequest request, StreamObserver<ListMigrationJobsResponse> responseObserver)

Lists migration jobs in a given project and location.

Parameters
Name	Description
`request`	`ListMigrationJobsRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<ListMigrationJobsResponse>`

listPrivateConnections(ListPrivateConnectionsRequest request, StreamObserver<ListPrivateConnectionsResponse> responseObserver)

public default void listPrivateConnections(ListPrivateConnectionsRequest request, StreamObserver<ListPrivateConnectionsResponse> responseObserver)

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

Parameters
Name	Description
`request`	`ListPrivateConnectionsRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<ListPrivateConnectionsResponse>`

promoteMigrationJob(PromoteMigrationJobRequest request, StreamObserver<Operation> responseObserver)

public default void promoteMigrationJob(PromoteMigrationJobRequest request, StreamObserver<Operation> responseObserver)

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

Parameters
Name	Description
`request`	`PromoteMigrationJobRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<Operation>`

restartMigrationJob(RestartMigrationJobRequest request, StreamObserver<Operation> responseObserver)

public default void restartMigrationJob(RestartMigrationJobRequest request, StreamObserver<Operation> responseObserver)

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

Parameters
Name	Description
`request`	`RestartMigrationJobRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<Operation>`

resumeMigrationJob(ResumeMigrationJobRequest request, StreamObserver<Operation> responseObserver)

public default void resumeMigrationJob(ResumeMigrationJobRequest request, StreamObserver<Operation> responseObserver)

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

Parameters
Name	Description
`request`	`ResumeMigrationJobRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<Operation>`

rollbackConversionWorkspace(RollbackConversionWorkspaceRequest request, StreamObserver<Operation> responseObserver)

public default void rollbackConversionWorkspace(RollbackConversionWorkspaceRequest request, StreamObserver<Operation> responseObserver)

Rolls back a conversion workspace to the last committed snapshot.

Parameters
Name	Description
`request`	`RollbackConversionWorkspaceRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<Operation>`

searchBackgroundJobs(SearchBackgroundJobsRequest request, StreamObserver<SearchBackgroundJobsResponse> responseObserver)

public default void searchBackgroundJobs(SearchBackgroundJobsRequest request, StreamObserver<SearchBackgroundJobsResponse> responseObserver)

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.

Parameters
Name	Description
`request`	`SearchBackgroundJobsRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<SearchBackgroundJobsResponse>`

seedConversionWorkspace(SeedConversionWorkspaceRequest request, StreamObserver<Operation> responseObserver)

public default void seedConversionWorkspace(SeedConversionWorkspaceRequest request, StreamObserver<Operation> responseObserver)

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

Parameters
Name	Description
`request`	`SeedConversionWorkspaceRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<Operation>`

startMigrationJob(StartMigrationJobRequest request, StreamObserver<Operation> responseObserver)

public default void startMigrationJob(StartMigrationJobRequest request, StreamObserver<Operation> responseObserver)

Start an already created migration job.

Parameters
Name	Description
`request`	`StartMigrationJobRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<Operation>`

stopMigrationJob(StopMigrationJobRequest request, StreamObserver<Operation> responseObserver)

public default void stopMigrationJob(StopMigrationJobRequest request, StreamObserver<Operation> responseObserver)

Stops a running migration job.

Parameters
Name	Description
`request`	`StopMigrationJobRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<Operation>`

updateConnectionProfile(UpdateConnectionProfileRequest request, StreamObserver<Operation> responseObserver)

public default void updateConnectionProfile(UpdateConnectionProfileRequest request, StreamObserver<Operation> responseObserver)

Update the configuration of a single connection profile.

Parameters
Name	Description
`request`	`UpdateConnectionProfileRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<Operation>`

updateConversionWorkspace(UpdateConversionWorkspaceRequest request, StreamObserver<Operation> responseObserver)

public default void updateConversionWorkspace(UpdateConversionWorkspaceRequest request, StreamObserver<Operation> responseObserver)

Updates the parameters of a single conversion workspace.

Parameters
Name	Description
`request`	`UpdateConversionWorkspaceRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<Operation>`

updateMigrationJob(UpdateMigrationJobRequest request, StreamObserver<Operation> responseObserver)

public default void updateMigrationJob(UpdateMigrationJobRequest request, StreamObserver<Operation> responseObserver)

Updates the parameters of a single migration job.

Parameters
Name	Description
`request`	`UpdateMigrationJobRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<Operation>`

verifyMigrationJob(VerifyMigrationJobRequest request, StreamObserver<Operation> responseObserver)

public default void verifyMigrationJob(VerifyMigrationJobRequest request, StreamObserver<Operation> responseObserver)

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

Parameters
Name	Description
`request`	`VerifyMigrationJobRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<Operation>`