Class DataMigrationServiceGrpc.DataMigrationServiceBlockingStub (2.39.0)

public static final class DataMigrationServiceGrpc.DataMigrationServiceBlockingStub extends AbstractBlockingStub<DataMigrationServiceGrpc.DataMigrationServiceBlockingStub>

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

Database Migration service

Inheritance

java.lang.Object > io.grpc.stub.AbstractStub > io.grpc.stub.AbstractBlockingStub > DataMigrationServiceGrpc.DataMigrationServiceBlockingStub

Methods

applyConversionWorkspace(ApplyConversionWorkspaceRequest request)

public Operation applyConversionWorkspace(ApplyConversionWorkspaceRequest request)

Applies draft tree onto a specific destination database.

Parameter
NameDescription
requestApplyConversionWorkspaceRequest
Returns
TypeDescription
Operation

build(Channel channel, CallOptions callOptions)

protected DataMigrationServiceGrpc.DataMigrationServiceBlockingStub build(Channel channel, CallOptions callOptions)
Parameters
NameDescription
channelio.grpc.Channel
callOptionsio.grpc.CallOptions
Returns
TypeDescription
DataMigrationServiceGrpc.DataMigrationServiceBlockingStub
Overrides
io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

commitConversionWorkspace(CommitConversionWorkspaceRequest request)

public Operation commitConversionWorkspace(CommitConversionWorkspaceRequest request)

Marks all the data in the conversion workspace as committed.

Parameter
NameDescription
requestCommitConversionWorkspaceRequest
Returns
TypeDescription
Operation

convertConversionWorkspace(ConvertConversionWorkspaceRequest request)

public Operation convertConversionWorkspace(ConvertConversionWorkspaceRequest request)

Creates a draft tree schema for the destination database.

Parameter
NameDescription
requestConvertConversionWorkspaceRequest
Returns
TypeDescription
Operation

createConnectionProfile(CreateConnectionProfileRequest request)

public Operation createConnectionProfile(CreateConnectionProfileRequest request)

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

Parameter
NameDescription
requestCreateConnectionProfileRequest
Returns
TypeDescription
Operation

createConversionWorkspace(CreateConversionWorkspaceRequest request)

public Operation createConversionWorkspace(CreateConversionWorkspaceRequest request)

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

Parameter
NameDescription
requestCreateConversionWorkspaceRequest
Returns
TypeDescription
Operation

createMappingRule(CreateMappingRuleRequest request)

public MappingRule createMappingRule(CreateMappingRuleRequest request)

Creates a new mapping rule for a given conversion workspace.

Parameter
NameDescription
requestCreateMappingRuleRequest
Returns
TypeDescription
MappingRule

createMigrationJob(CreateMigrationJobRequest request)

public Operation createMigrationJob(CreateMigrationJobRequest request)

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

Parameter
NameDescription
requestCreateMigrationJobRequest
Returns
TypeDescription
Operation

createPrivateConnection(CreatePrivateConnectionRequest request)

public Operation createPrivateConnection(CreatePrivateConnectionRequest request)

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

Parameter
NameDescription
requestCreatePrivateConnectionRequest
Returns
TypeDescription
Operation

deleteConnectionProfile(DeleteConnectionProfileRequest request)

public 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
NameDescription
requestDeleteConnectionProfileRequest
Returns
TypeDescription
Operation

deleteConversionWorkspace(DeleteConversionWorkspaceRequest request)

public Operation deleteConversionWorkspace(DeleteConversionWorkspaceRequest request)

Deletes a single conversion workspace.

Parameter
NameDescription
requestDeleteConversionWorkspaceRequest
Returns
TypeDescription
Operation

deleteMappingRule(DeleteMappingRuleRequest request)

public Empty deleteMappingRule(DeleteMappingRuleRequest request)

Deletes a single mapping rule.

Parameter
NameDescription
requestDeleteMappingRuleRequest
Returns
TypeDescription
Empty

deleteMigrationJob(DeleteMigrationJobRequest request)

public Operation deleteMigrationJob(DeleteMigrationJobRequest request)

Deletes a single migration job.

Parameter
NameDescription
requestDeleteMigrationJobRequest
Returns
TypeDescription
Operation

deletePrivateConnection(DeletePrivateConnectionRequest request)

public Operation deletePrivateConnection(DeletePrivateConnectionRequest request)

Deletes a single Database Migration Service private connection.

Parameter
NameDescription
requestDeletePrivateConnectionRequest
Returns
TypeDescription
Operation

describeConversionWorkspaceRevisions(DescribeConversionWorkspaceRevisionsRequest request)

public DescribeConversionWorkspaceRevisionsResponse describeConversionWorkspaceRevisions(DescribeConversionWorkspaceRevisionsRequest request)

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

Parameter
NameDescription
requestDescribeConversionWorkspaceRevisionsRequest
Returns
TypeDescription
DescribeConversionWorkspaceRevisionsResponse

describeDatabaseEntities(DescribeDatabaseEntitiesRequest request)

public 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
NameDescription
requestDescribeDatabaseEntitiesRequest
Returns
TypeDescription
DescribeDatabaseEntitiesResponse

fetchStaticIps(FetchStaticIpsRequest request)

public 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
NameDescription
requestFetchStaticIpsRequest
Returns
TypeDescription
FetchStaticIpsResponse

generateSshScript(GenerateSshScriptRequest request)

public SshScript generateSshScript(GenerateSshScriptRequest request)

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

Parameter
NameDescription
requestGenerateSshScriptRequest
Returns
TypeDescription
SshScript

generateTcpProxyScript(GenerateTcpProxyScriptRequest request)

public TcpProxyScript generateTcpProxyScript(GenerateTcpProxyScriptRequest request)

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

Parameter
NameDescription
requestGenerateTcpProxyScriptRequest
Returns
TypeDescription
TcpProxyScript

getConnectionProfile(GetConnectionProfileRequest request)

public ConnectionProfile getConnectionProfile(GetConnectionProfileRequest request)

Gets details of a single connection profile.

Parameter
NameDescription
requestGetConnectionProfileRequest
Returns
TypeDescription
ConnectionProfile

getConversionWorkspace(GetConversionWorkspaceRequest request)

public ConversionWorkspace getConversionWorkspace(GetConversionWorkspaceRequest request)

Gets details of a single conversion workspace.

Parameter
NameDescription
requestGetConversionWorkspaceRequest
Returns
TypeDescription
ConversionWorkspace

getMappingRule(GetMappingRuleRequest request)

public MappingRule getMappingRule(GetMappingRuleRequest request)

Gets the details of a mapping rule.

Parameter
NameDescription
requestGetMappingRuleRequest
Returns
TypeDescription
MappingRule

getMigrationJob(GetMigrationJobRequest request)

public MigrationJob getMigrationJob(GetMigrationJobRequest request)

Gets details of a single migration job.

Parameter
NameDescription
requestGetMigrationJobRequest
Returns
TypeDescription
MigrationJob

getPrivateConnection(GetPrivateConnectionRequest request)

public PrivateConnection getPrivateConnection(GetPrivateConnectionRequest request)

Gets details of a single private connection.

Parameter
NameDescription
requestGetPrivateConnectionRequest
Returns
TypeDescription
PrivateConnection

importMappingRules(ImportMappingRulesRequest request)

public Operation importMappingRules(ImportMappingRulesRequest request)

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

Parameter
NameDescription
requestImportMappingRulesRequest
Returns
TypeDescription
Operation

listConnectionProfiles(ListConnectionProfilesRequest request)

public ListConnectionProfilesResponse listConnectionProfiles(ListConnectionProfilesRequest request)

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

Parameter
NameDescription
requestListConnectionProfilesRequest
Returns
TypeDescription
ListConnectionProfilesResponse

listConversionWorkspaces(ListConversionWorkspacesRequest request)

public ListConversionWorkspacesResponse listConversionWorkspaces(ListConversionWorkspacesRequest request)

Lists conversion workspaces in a given project and location.

Parameter
NameDescription
requestListConversionWorkspacesRequest
Returns
TypeDescription
ListConversionWorkspacesResponse

listMappingRules(ListMappingRulesRequest request)

public ListMappingRulesResponse listMappingRules(ListMappingRulesRequest request)

Lists the mapping rules for a specific conversion workspace.

Parameter
NameDescription
requestListMappingRulesRequest
Returns
TypeDescription
ListMappingRulesResponse

listMigrationJobs(ListMigrationJobsRequest request)

public ListMigrationJobsResponse listMigrationJobs(ListMigrationJobsRequest request)

Lists migration jobs in a given project and location.

Parameter
NameDescription
requestListMigrationJobsRequest
Returns
TypeDescription
ListMigrationJobsResponse

listPrivateConnections(ListPrivateConnectionsRequest request)

public ListPrivateConnectionsResponse listPrivateConnections(ListPrivateConnectionsRequest request)

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

Parameter
NameDescription
requestListPrivateConnectionsRequest
Returns
TypeDescription
ListPrivateConnectionsResponse

promoteMigrationJob(PromoteMigrationJobRequest request)

public Operation promoteMigrationJob(PromoteMigrationJobRequest request)

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

Parameter
NameDescription
requestPromoteMigrationJobRequest
Returns
TypeDescription
Operation

restartMigrationJob(RestartMigrationJobRequest request)

public 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
NameDescription
requestRestartMigrationJobRequest
Returns
TypeDescription
Operation

resumeMigrationJob(ResumeMigrationJobRequest request)

public Operation resumeMigrationJob(ResumeMigrationJobRequest request)

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

Parameter
NameDescription
requestResumeMigrationJobRequest
Returns
TypeDescription
Operation

rollbackConversionWorkspace(RollbackConversionWorkspaceRequest request)

public Operation rollbackConversionWorkspace(RollbackConversionWorkspaceRequest request)

Rolls back a conversion workspace to the last committed snapshot.

Parameter
NameDescription
requestRollbackConversionWorkspaceRequest
Returns
TypeDescription
Operation

searchBackgroundJobs(SearchBackgroundJobsRequest request)

public 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
NameDescription
requestSearchBackgroundJobsRequest
Returns
TypeDescription
SearchBackgroundJobsResponse

seedConversionWorkspace(SeedConversionWorkspaceRequest request)

public Operation seedConversionWorkspace(SeedConversionWorkspaceRequest request)

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

Parameter
NameDescription
requestSeedConversionWorkspaceRequest
Returns
TypeDescription
Operation

startMigrationJob(StartMigrationJobRequest request)

public Operation startMigrationJob(StartMigrationJobRequest request)

Start an already created migration job.

Parameter
NameDescription
requestStartMigrationJobRequest
Returns
TypeDescription
Operation

stopMigrationJob(StopMigrationJobRequest request)

public Operation stopMigrationJob(StopMigrationJobRequest request)

Stops a running migration job.

Parameter
NameDescription
requestStopMigrationJobRequest
Returns
TypeDescription
Operation

updateConnectionProfile(UpdateConnectionProfileRequest request)

public Operation updateConnectionProfile(UpdateConnectionProfileRequest request)

Update the configuration of a single connection profile.

Parameter
NameDescription
requestUpdateConnectionProfileRequest
Returns
TypeDescription
Operation

updateConversionWorkspace(UpdateConversionWorkspaceRequest request)

public Operation updateConversionWorkspace(UpdateConversionWorkspaceRequest request)

Updates the parameters of a single conversion workspace.

Parameter
NameDescription
requestUpdateConversionWorkspaceRequest
Returns
TypeDescription
Operation

updateMigrationJob(UpdateMigrationJobRequest request)

public Operation updateMigrationJob(UpdateMigrationJobRequest request)

Updates the parameters of a single migration job.

Parameter
NameDescription
requestUpdateMigrationJobRequest
Returns
TypeDescription
Operation

verifyMigrationJob(VerifyMigrationJobRequest request)

public 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
NameDescription
requestVerifyMigrationJobRequest
Returns
TypeDescription
Operation