Class DataMigrationService.DataMigrationServiceBase (2.0.0)

[BindServiceMethod(typeof(DataMigrationService), "BindService")]
public abstract class 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

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
`Task<Operation>`	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
`Task<Operation>`	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
`Task<Operation>`	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
`Task<Operation>`	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
`Task<SshScript>`	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
`Task<ConnectionProfile>`	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
`Task<MigrationJob>`	The response to send back to the client (wrapped by a task).

ListConnectionProfiles(ListConnectionProfilesRequest, ServerCallContext)

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

Retrieve 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
`Task<ListConnectionProfilesResponse>`	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
`Task<ListMigrationJobsResponse>`	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
`Task<Operation>`	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
`Task<Operation>`	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
`Task<Operation>`	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
`Task<Operation>`	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
`Task<Operation>`	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
`Task<Operation>`	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
`Task<Operation>`	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
`Task<Operation>`	The response to send back to the client (wrapped by a task).