Database Migration v1 API - Class DataMigrationService.DataMigrationServiceBase (2.2.0)

Version 2.2.0

• 2.5.0 (latest)
• 2.4.0
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.0
• 1.2.0
• 1.1.0
• 1.0.0

[BindServiceMethod(typeof(DataMigrationService), "BindService")]
public abstract class DataMigrationService.DataMigrationServiceBase

Reference documentation and code samples for the Database Migration v1 API class DataMigrationService.DataMigrationServiceBase.

Base class for server-side implementations of DataMigrationService

Inheritance

object > DataMigrationService.DataMigrationServiceBase

Inherited Members

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.CloudDms.V1

Assembly

Google.Cloud.CloudDms.V1.dll

Methods

ApplyConversionWorkspace(ApplyConversionWorkspaceRequest, ServerCallContext)

public virtual Task<Operation> ApplyConversionWorkspace(ApplyConversionWorkspaceRequest request, ServerCallContext context)

Applies draft tree onto a specific destination database.

Parameters
Name	Description
request	ApplyConversionWorkspaceRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

CommitConversionWorkspace(CommitConversionWorkspaceRequest, ServerCallContext)

public virtual Task<Operation> CommitConversionWorkspace(CommitConversionWorkspaceRequest request, ServerCallContext context)

Marks all the data in the conversion workspace as committed.

Parameters
Name	Description
request	CommitConversionWorkspaceRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

ConvertConversionWorkspace(ConvertConversionWorkspaceRequest, ServerCallContext)

public virtual Task<Operation> ConvertConversionWorkspace(ConvertConversionWorkspaceRequest request, ServerCallContext context)

Creates a draft tree schema for the destination database.

Parameters
Name	Description
request	ConvertConversionWorkspaceRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

CreateConnectionProfile(CreateConnectionProfileRequest, ServerCallContext)

public virtual Task<Operation> CreateConnectionProfile(CreateConnectionProfileRequest request, ServerCallContext context)

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

Parameters
Name	Description
request	CreateConnectionProfileRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

CreateConversionWorkspace(CreateConversionWorkspaceRequest, ServerCallContext)

public virtual Task<Operation> CreateConversionWorkspace(CreateConversionWorkspaceRequest request, ServerCallContext context)

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

Parameters
Name	Description
request	CreateConversionWorkspaceRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

CreateMappingRule(CreateMappingRuleRequest, ServerCallContext)

public virtual Task<MappingRule> CreateMappingRule(CreateMappingRuleRequest request, ServerCallContext context)

Creates a new mapping rule for a given conversion workspace.

Parameters
Name	Description
request	CreateMappingRuleRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskMappingRule	The response to send back to the client (wrapped by a task).

CreateMigrationJob(CreateMigrationJobRequest, ServerCallContext)

public virtual Task<Operation> CreateMigrationJob(CreateMigrationJobRequest request, ServerCallContext context)

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

Parameters
Name	Description
request	CreateMigrationJobRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

CreatePrivateConnection(CreatePrivateConnectionRequest, ServerCallContext)

public virtual Task<Operation> CreatePrivateConnection(CreatePrivateConnectionRequest request, ServerCallContext context)

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

Parameters
Name	Description
request	CreatePrivateConnectionRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

DeleteConnectionProfile(DeleteConnectionProfileRequest, ServerCallContext)

public virtual Task<Operation> DeleteConnectionProfile(DeleteConnectionProfileRequest request, ServerCallContext context)

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 The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

DeleteConversionWorkspace(DeleteConversionWorkspaceRequest, ServerCallContext)

public virtual Task<Operation> DeleteConversionWorkspace(DeleteConversionWorkspaceRequest request, ServerCallContext context)

Deletes a single conversion workspace.

Parameters
Name	Description
request	DeleteConversionWorkspaceRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

DeleteMappingRule(DeleteMappingRuleRequest, ServerCallContext)

public virtual Task<Empty> DeleteMappingRule(DeleteMappingRuleRequest request, ServerCallContext context)

Deletes a single mapping rule.

Parameters
Name	Description
request	DeleteMappingRuleRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskEmpty	The response to send back to the client (wrapped by a task).

DeleteMigrationJob(DeleteMigrationJobRequest, ServerCallContext)

public virtual Task<Operation> DeleteMigrationJob(DeleteMigrationJobRequest request, ServerCallContext context)

Deletes a single migration job.

Parameters
Name	Description
request	DeleteMigrationJobRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

DeletePrivateConnection(DeletePrivateConnectionRequest, ServerCallContext)

public virtual Task<Operation> DeletePrivateConnection(DeletePrivateConnectionRequest request, ServerCallContext context)

Deletes a single Database Migration Service private connection.

Parameters
Name	Description
request	DeletePrivateConnectionRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

DescribeConversionWorkspaceRevisions(DescribeConversionWorkspaceRevisionsRequest, ServerCallContext)

public virtual Task<DescribeConversionWorkspaceRevisionsResponse> DescribeConversionWorkspaceRevisions(DescribeConversionWorkspaceRevisionsRequest request, ServerCallContext context)

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

Parameters
Name	Description
request	DescribeConversionWorkspaceRevisionsRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskDescribeConversionWorkspaceRevisionsResponse	The response to send back to the client (wrapped by a task).

DescribeDatabaseEntities(DescribeDatabaseEntitiesRequest, ServerCallContext)

public virtual Task<DescribeDatabaseEntitiesResponse> DescribeDatabaseEntities(DescribeDatabaseEntitiesRequest request, ServerCallContext context)

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 The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskDescribeDatabaseEntitiesResponse	The response to send back to the client (wrapped by a task).

FetchStaticIps(FetchStaticIpsRequest, ServerCallContext)

public virtual Task<FetchStaticIpsResponse> FetchStaticIps(FetchStaticIpsRequest request, ServerCallContext context)

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 The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskFetchStaticIpsResponse	The response to send back to the client (wrapped by a task).

GenerateSshScript(GenerateSshScriptRequest, ServerCallContext)

public virtual Task<SshScript> GenerateSshScript(GenerateSshScriptRequest request, ServerCallContext context)

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

Parameters
Name	Description
request	GenerateSshScriptRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskSshScript	The response to send back to the client (wrapped by a task).

GenerateTcpProxyScript(GenerateTcpProxyScriptRequest, ServerCallContext)

public virtual Task<TcpProxyScript> GenerateTcpProxyScript(GenerateTcpProxyScriptRequest request, ServerCallContext context)

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

Parameters
Name	Description
request	GenerateTcpProxyScriptRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskTcpProxyScript	The response to send back to the client (wrapped by a task).

GetConnectionProfile(GetConnectionProfileRequest, ServerCallContext)

public virtual Task<ConnectionProfile> GetConnectionProfile(GetConnectionProfileRequest request, ServerCallContext context)

Gets details of a single connection profile.

Parameters
Name	Description
request	GetConnectionProfileRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskConnectionProfile	The response to send back to the client (wrapped by a task).

GetConversionWorkspace(GetConversionWorkspaceRequest, ServerCallContext)

public virtual Task<ConversionWorkspace> GetConversionWorkspace(GetConversionWorkspaceRequest request, ServerCallContext context)

Gets details of a single conversion workspace.

Parameters
Name	Description
request	GetConversionWorkspaceRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskConversionWorkspace	The response to send back to the client (wrapped by a task).

GetMappingRule(GetMappingRuleRequest, ServerCallContext)

public virtual Task<MappingRule> GetMappingRule(GetMappingRuleRequest request, ServerCallContext context)

Gets the details of a mapping rule.

Parameters
Name	Description
request	GetMappingRuleRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskMappingRule	The response to send back to the client (wrapped by a task).

GetMigrationJob(GetMigrationJobRequest, ServerCallContext)

public virtual Task<MigrationJob> GetMigrationJob(GetMigrationJobRequest request, ServerCallContext context)

Gets details of a single migration job.

Parameters
Name	Description
request	GetMigrationJobRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskMigrationJob	The response to send back to the client (wrapped by a task).

GetPrivateConnection(GetPrivateConnectionRequest, ServerCallContext)

public virtual Task<PrivateConnection> GetPrivateConnection(GetPrivateConnectionRequest request, ServerCallContext context)

Gets details of a single private connection.

Parameters
Name	Description
request	GetPrivateConnectionRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskPrivateConnection	The response to send back to the client (wrapped by a task).

ImportMappingRules(ImportMappingRulesRequest, ServerCallContext)

public virtual Task<Operation> ImportMappingRules(ImportMappingRulesRequest request, ServerCallContext context)

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

Parameters
Name	Description
request	ImportMappingRulesRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

ListConnectionProfiles(ListConnectionProfilesRequest, ServerCallContext)

public virtual Task<ListConnectionProfilesResponse> ListConnectionProfiles(ListConnectionProfilesRequest request, ServerCallContext context)

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

Parameters
Name	Description
request	ListConnectionProfilesRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskListConnectionProfilesResponse	The response to send back to the client (wrapped by a task).

ListConversionWorkspaces(ListConversionWorkspacesRequest, ServerCallContext)

public virtual Task<ListConversionWorkspacesResponse> ListConversionWorkspaces(ListConversionWorkspacesRequest request, ServerCallContext context)

Lists conversion workspaces in a given project and location.

Parameters
Name	Description
request	ListConversionWorkspacesRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskListConversionWorkspacesResponse	The response to send back to the client (wrapped by a task).

ListMappingRules(ListMappingRulesRequest, ServerCallContext)

public virtual Task<ListMappingRulesResponse> ListMappingRules(ListMappingRulesRequest request, ServerCallContext context)

Lists the mapping rules for a specific conversion workspace.

Parameters
Name	Description
request	ListMappingRulesRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskListMappingRulesResponse	The response to send back to the client (wrapped by a task).

ListMigrationJobs(ListMigrationJobsRequest, ServerCallContext)

public virtual Task<ListMigrationJobsResponse> ListMigrationJobs(ListMigrationJobsRequest request, ServerCallContext context)

Lists migration jobs in a given project and location.

Parameters
Name	Description
request	ListMigrationJobsRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskListMigrationJobsResponse	The response to send back to the client (wrapped by a task).

ListPrivateConnections(ListPrivateConnectionsRequest, ServerCallContext)

public virtual Task<ListPrivateConnectionsResponse> ListPrivateConnections(ListPrivateConnectionsRequest request, ServerCallContext context)

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

Parameters
Name	Description
request	ListPrivateConnectionsRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskListPrivateConnectionsResponse	The response to send back to the client (wrapped by a task).

PromoteMigrationJob(PromoteMigrationJobRequest, ServerCallContext)

public virtual Task<Operation> PromoteMigrationJob(PromoteMigrationJobRequest request, ServerCallContext context)

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

Parameters
Name	Description
request	PromoteMigrationJobRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

RestartMigrationJob(RestartMigrationJobRequest, ServerCallContext)

public virtual Task<Operation> RestartMigrationJob(RestartMigrationJobRequest request, ServerCallContext context)

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 The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

ResumeMigrationJob(ResumeMigrationJobRequest, ServerCallContext)

public virtual Task<Operation> ResumeMigrationJob(ResumeMigrationJobRequest request, ServerCallContext context)

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

Parameters
Name	Description
request	ResumeMigrationJobRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

RollbackConversionWorkspace(RollbackConversionWorkspaceRequest, ServerCallContext)

public virtual Task<Operation> RollbackConversionWorkspace(RollbackConversionWorkspaceRequest request, ServerCallContext context)

Rolls back a conversion workspace to the last committed snapshot.

Parameters
Name	Description
request	RollbackConversionWorkspaceRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

SearchBackgroundJobs(SearchBackgroundJobsRequest, ServerCallContext)

public virtual Task<SearchBackgroundJobsResponse> SearchBackgroundJobs(SearchBackgroundJobsRequest request, ServerCallContext context)

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 The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskSearchBackgroundJobsResponse	The response to send back to the client (wrapped by a task).

SeedConversionWorkspace(SeedConversionWorkspaceRequest, ServerCallContext)

public virtual Task<Operation> SeedConversionWorkspace(SeedConversionWorkspaceRequest request, ServerCallContext context)

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

Parameters
Name	Description
request	SeedConversionWorkspaceRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

StartMigrationJob(StartMigrationJobRequest, ServerCallContext)

public virtual Task<Operation> StartMigrationJob(StartMigrationJobRequest request, ServerCallContext context)

Start an already created migration job.

Parameters
Name	Description
request	StartMigrationJobRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

StopMigrationJob(StopMigrationJobRequest, ServerCallContext)

public virtual Task<Operation> StopMigrationJob(StopMigrationJobRequest request, ServerCallContext context)

Stops a running migration job.

Parameters
Name	Description
request	StopMigrationJobRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

UpdateConnectionProfile(UpdateConnectionProfileRequest, ServerCallContext)

public virtual Task<Operation> UpdateConnectionProfile(UpdateConnectionProfileRequest request, ServerCallContext context)

Update the configuration of a single connection profile.

Parameters
Name	Description
request	UpdateConnectionProfileRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

UpdateConversionWorkspace(UpdateConversionWorkspaceRequest, ServerCallContext)

public virtual Task<Operation> UpdateConversionWorkspace(UpdateConversionWorkspaceRequest request, ServerCallContext context)

Updates the parameters of a single conversion workspace.

Parameters
Name	Description
request	UpdateConversionWorkspaceRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

UpdateMigrationJob(UpdateMigrationJobRequest, ServerCallContext)

public virtual Task<Operation> UpdateMigrationJob(UpdateMigrationJobRequest request, ServerCallContext context)

Updates the parameters of a single migration job.

Parameters
Name	Description
request	UpdateMigrationJobRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

VerifyMigrationJob(VerifyMigrationJobRequest, ServerCallContext)

public virtual Task<Operation> VerifyMigrationJob(VerifyMigrationJobRequest request, ServerCallContext context)

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 The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).