Class DataMigrationService.DataMigrationServiceClient (1.0.0)

public class DataMigrationServiceClient : ClientBase<DataMigrationService.DataMigrationServiceClient>

Client for DataMigrationService

Inheritance

Object > ClientBase > ClientBase<DataMigrationService.DataMigrationServiceClient> > DataMigrationService.DataMigrationServiceClient

Namespace

Google.Cloud.CloudDms.V1

Assembly

Google.Cloud.CloudDms.V1.dll

Constructors

DataMigrationServiceClient()

protected DataMigrationServiceClient()

Protected parameterless constructor to allow creation of test doubles.

DataMigrationServiceClient(CallInvoker)

public DataMigrationServiceClient(CallInvoker callInvoker)

Creates a new client for DataMigrationService that uses a custom CallInvoker.

Parameter
NameDescription
callInvokerCallInvoker

The callInvoker to use to make remote calls.

DataMigrationServiceClient(ChannelBase)

public DataMigrationServiceClient(ChannelBase channel)

Creates a new client for DataMigrationService

Parameter
NameDescription
channelChannelBase

The channel to use to make remote calls.

DataMigrationServiceClient(ClientBase.ClientBaseConfiguration)

protected DataMigrationServiceClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
NameDescription
configurationClientBase.ClientBaseConfiguration

The client configuration.

Methods

CreateConnectionProfile(CreateConnectionProfileRequest, CallOptions)

public virtual Operation CreateConnectionProfile(CreateConnectionProfileRequest request, CallOptions options)

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

Parameters
NameDescription
requestCreateConnectionProfileRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

CreateConnectionProfile(CreateConnectionProfileRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Operation CreateConnectionProfile(CreateConnectionProfileRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

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

Parameters
NameDescription
requestCreateConnectionProfileRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

CreateConnectionProfileAsync(CreateConnectionProfileRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> CreateConnectionProfileAsync(CreateConnectionProfileRequest request, CallOptions options)

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

Parameters
NameDescription
requestCreateConnectionProfileRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

CreateConnectionProfileAsync(CreateConnectionProfileRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Operation> CreateConnectionProfileAsync(CreateConnectionProfileRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

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

Parameters
NameDescription
requestCreateConnectionProfileRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

CreateMigrationJob(CreateMigrationJobRequest, CallOptions)

public virtual Operation CreateMigrationJob(CreateMigrationJobRequest request, CallOptions options)

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

Parameters
NameDescription
requestCreateMigrationJobRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

CreateMigrationJob(CreateMigrationJobRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Operation CreateMigrationJob(CreateMigrationJobRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

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

Parameters
NameDescription
requestCreateMigrationJobRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

CreateMigrationJobAsync(CreateMigrationJobRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> CreateMigrationJobAsync(CreateMigrationJobRequest request, CallOptions options)

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

Parameters
NameDescription
requestCreateMigrationJobRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

CreateMigrationJobAsync(CreateMigrationJobRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Operation> CreateMigrationJobAsync(CreateMigrationJobRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

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

Parameters
NameDescription
requestCreateMigrationJobRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

CreateOperationsClient()

public virtual Operations.OperationsClient CreateOperationsClient()

Creates a new instance of Operations.OperationsClient using the same call invoker as this client.

Returns
TypeDescription
Operations.OperationsClient

A new Operations client for the same target as this client.

DeleteConnectionProfile(DeleteConnectionProfileRequest, CallOptions)

public virtual Operation DeleteConnectionProfile(DeleteConnectionProfileRequest request, CallOptions options)

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
NameDescription
requestDeleteConnectionProfileRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

DeleteConnectionProfile(DeleteConnectionProfileRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Operation DeleteConnectionProfile(DeleteConnectionProfileRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

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
NameDescription
requestDeleteConnectionProfileRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

DeleteConnectionProfileAsync(DeleteConnectionProfileRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> DeleteConnectionProfileAsync(DeleteConnectionProfileRequest request, CallOptions options)

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
NameDescription
requestDeleteConnectionProfileRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

DeleteConnectionProfileAsync(DeleteConnectionProfileRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Operation> DeleteConnectionProfileAsync(DeleteConnectionProfileRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

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
NameDescription
requestDeleteConnectionProfileRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

DeleteMigrationJob(DeleteMigrationJobRequest, CallOptions)

public virtual Operation DeleteMigrationJob(DeleteMigrationJobRequest request, CallOptions options)

Deletes a single migration job.

Parameters
NameDescription
requestDeleteMigrationJobRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

DeleteMigrationJob(DeleteMigrationJobRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Operation DeleteMigrationJob(DeleteMigrationJobRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Deletes a single migration job.

Parameters
NameDescription
requestDeleteMigrationJobRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

DeleteMigrationJobAsync(DeleteMigrationJobRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> DeleteMigrationJobAsync(DeleteMigrationJobRequest request, CallOptions options)

Deletes a single migration job.

Parameters
NameDescription
requestDeleteMigrationJobRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

DeleteMigrationJobAsync(DeleteMigrationJobRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Operation> DeleteMigrationJobAsync(DeleteMigrationJobRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Deletes a single migration job.

Parameters
NameDescription
requestDeleteMigrationJobRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

GenerateSshScript(GenerateSshScriptRequest, CallOptions)

public virtual SshScript GenerateSshScript(GenerateSshScriptRequest request, CallOptions options)

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

Parameters
NameDescription
requestGenerateSshScriptRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
SshScript

The response received from the server.

GenerateSshScript(GenerateSshScriptRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual SshScript GenerateSshScript(GenerateSshScriptRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

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

Parameters
NameDescription
requestGenerateSshScriptRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
SshScript

The response received from the server.

GenerateSshScriptAsync(GenerateSshScriptRequest, CallOptions)

public virtual AsyncUnaryCall<SshScript> GenerateSshScriptAsync(GenerateSshScriptRequest request, CallOptions options)

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

Parameters
NameDescription
requestGenerateSshScriptRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<SshScript>

The call object.

GenerateSshScriptAsync(GenerateSshScriptRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<SshScript> GenerateSshScriptAsync(GenerateSshScriptRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

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

Parameters
NameDescription
requestGenerateSshScriptRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<SshScript>

The call object.

GetConnectionProfile(GetConnectionProfileRequest, CallOptions)

public virtual ConnectionProfile GetConnectionProfile(GetConnectionProfileRequest request, CallOptions options)

Gets details of a single connection profile.

Parameters
NameDescription
requestGetConnectionProfileRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
ConnectionProfile

The response received from the server.

GetConnectionProfile(GetConnectionProfileRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual ConnectionProfile GetConnectionProfile(GetConnectionProfileRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Gets details of a single connection profile.

Parameters
NameDescription
requestGetConnectionProfileRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
ConnectionProfile

The response received from the server.

GetConnectionProfileAsync(GetConnectionProfileRequest, CallOptions)

public virtual AsyncUnaryCall<ConnectionProfile> GetConnectionProfileAsync(GetConnectionProfileRequest request, CallOptions options)

Gets details of a single connection profile.

Parameters
NameDescription
requestGetConnectionProfileRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<ConnectionProfile>

The call object.

GetConnectionProfileAsync(GetConnectionProfileRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<ConnectionProfile> GetConnectionProfileAsync(GetConnectionProfileRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Gets details of a single connection profile.

Parameters
NameDescription
requestGetConnectionProfileRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<ConnectionProfile>

The call object.

GetMigrationJob(GetMigrationJobRequest, CallOptions)

public virtual MigrationJob GetMigrationJob(GetMigrationJobRequest request, CallOptions options)

Gets details of a single migration job.

Parameters
NameDescription
requestGetMigrationJobRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
MigrationJob

The response received from the server.

GetMigrationJob(GetMigrationJobRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual MigrationJob GetMigrationJob(GetMigrationJobRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Gets details of a single migration job.

Parameters
NameDescription
requestGetMigrationJobRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
MigrationJob

The response received from the server.

GetMigrationJobAsync(GetMigrationJobRequest, CallOptions)

public virtual AsyncUnaryCall<MigrationJob> GetMigrationJobAsync(GetMigrationJobRequest request, CallOptions options)

Gets details of a single migration job.

Parameters
NameDescription
requestGetMigrationJobRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<MigrationJob>

The call object.

GetMigrationJobAsync(GetMigrationJobRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<MigrationJob> GetMigrationJobAsync(GetMigrationJobRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Gets details of a single migration job.

Parameters
NameDescription
requestGetMigrationJobRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<MigrationJob>

The call object.

ListConnectionProfiles(ListConnectionProfilesRequest, CallOptions)

public virtual ListConnectionProfilesResponse ListConnectionProfiles(ListConnectionProfilesRequest request, CallOptions options)

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

Parameters
NameDescription
requestListConnectionProfilesRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
ListConnectionProfilesResponse

The response received from the server.

ListConnectionProfiles(ListConnectionProfilesRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual ListConnectionProfilesResponse ListConnectionProfiles(ListConnectionProfilesRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

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

Parameters
NameDescription
requestListConnectionProfilesRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
ListConnectionProfilesResponse

The response received from the server.

ListConnectionProfilesAsync(ListConnectionProfilesRequest, CallOptions)

public virtual AsyncUnaryCall<ListConnectionProfilesResponse> ListConnectionProfilesAsync(ListConnectionProfilesRequest request, CallOptions options)

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

Parameters
NameDescription
requestListConnectionProfilesRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<ListConnectionProfilesResponse>

The call object.

ListConnectionProfilesAsync(ListConnectionProfilesRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<ListConnectionProfilesResponse> ListConnectionProfilesAsync(ListConnectionProfilesRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

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

Parameters
NameDescription
requestListConnectionProfilesRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<ListConnectionProfilesResponse>

The call object.

ListMigrationJobs(ListMigrationJobsRequest, CallOptions)

public virtual ListMigrationJobsResponse ListMigrationJobs(ListMigrationJobsRequest request, CallOptions options)

Lists migration jobs in a given project and location.

Parameters
NameDescription
requestListMigrationJobsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
ListMigrationJobsResponse

The response received from the server.

ListMigrationJobs(ListMigrationJobsRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual ListMigrationJobsResponse ListMigrationJobs(ListMigrationJobsRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Lists migration jobs in a given project and location.

Parameters
NameDescription
requestListMigrationJobsRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
ListMigrationJobsResponse

The response received from the server.

ListMigrationJobsAsync(ListMigrationJobsRequest, CallOptions)

public virtual AsyncUnaryCall<ListMigrationJobsResponse> ListMigrationJobsAsync(ListMigrationJobsRequest request, CallOptions options)

Lists migration jobs in a given project and location.

Parameters
NameDescription
requestListMigrationJobsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<ListMigrationJobsResponse>

The call object.

ListMigrationJobsAsync(ListMigrationJobsRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<ListMigrationJobsResponse> ListMigrationJobsAsync(ListMigrationJobsRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Lists migration jobs in a given project and location.

Parameters
NameDescription
requestListMigrationJobsRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<ListMigrationJobsResponse>

The call object.

NewInstance(ClientBase.ClientBaseConfiguration)

protected override DataMigrationService.DataMigrationServiceClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
NameDescription
configurationClientBase.ClientBaseConfiguration
Returns
TypeDescription
DataMigrationService.DataMigrationServiceClient
Overrides
Grpc.Core.ClientBase<Google.Cloud.CloudDms.V1.DataMigrationService.DataMigrationServiceClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)

PromoteMigrationJob(PromoteMigrationJobRequest, CallOptions)

public virtual Operation PromoteMigrationJob(PromoteMigrationJobRequest request, CallOptions options)

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

Parameters
NameDescription
requestPromoteMigrationJobRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

PromoteMigrationJob(PromoteMigrationJobRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Operation PromoteMigrationJob(PromoteMigrationJobRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

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

Parameters
NameDescription
requestPromoteMigrationJobRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

PromoteMigrationJobAsync(PromoteMigrationJobRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> PromoteMigrationJobAsync(PromoteMigrationJobRequest request, CallOptions options)

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

Parameters
NameDescription
requestPromoteMigrationJobRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

PromoteMigrationJobAsync(PromoteMigrationJobRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Operation> PromoteMigrationJobAsync(PromoteMigrationJobRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

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

Parameters
NameDescription
requestPromoteMigrationJobRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

RestartMigrationJob(RestartMigrationJobRequest, CallOptions)

public virtual Operation RestartMigrationJob(RestartMigrationJobRequest request, CallOptions options)

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

Parameters
NameDescription
requestRestartMigrationJobRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

RestartMigrationJob(RestartMigrationJobRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Operation RestartMigrationJob(RestartMigrationJobRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

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

Parameters
NameDescription
requestRestartMigrationJobRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

RestartMigrationJobAsync(RestartMigrationJobRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> RestartMigrationJobAsync(RestartMigrationJobRequest request, CallOptions options)

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

Parameters
NameDescription
requestRestartMigrationJobRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

RestartMigrationJobAsync(RestartMigrationJobRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Operation> RestartMigrationJobAsync(RestartMigrationJobRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

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

Parameters
NameDescription
requestRestartMigrationJobRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

ResumeMigrationJob(ResumeMigrationJobRequest, CallOptions)

public virtual Operation ResumeMigrationJob(ResumeMigrationJobRequest request, CallOptions options)

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

Parameters
NameDescription
requestResumeMigrationJobRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

ResumeMigrationJob(ResumeMigrationJobRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Operation ResumeMigrationJob(ResumeMigrationJobRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

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

Parameters
NameDescription
requestResumeMigrationJobRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

ResumeMigrationJobAsync(ResumeMigrationJobRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> ResumeMigrationJobAsync(ResumeMigrationJobRequest request, CallOptions options)

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

Parameters
NameDescription
requestResumeMigrationJobRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

ResumeMigrationJobAsync(ResumeMigrationJobRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Operation> ResumeMigrationJobAsync(ResumeMigrationJobRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

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

Parameters
NameDescription
requestResumeMigrationJobRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

StartMigrationJob(StartMigrationJobRequest, CallOptions)

public virtual Operation StartMigrationJob(StartMigrationJobRequest request, CallOptions options)

Start an already created migration job.

Parameters
NameDescription
requestStartMigrationJobRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

StartMigrationJob(StartMigrationJobRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Operation StartMigrationJob(StartMigrationJobRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Start an already created migration job.

Parameters
NameDescription
requestStartMigrationJobRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

StartMigrationJobAsync(StartMigrationJobRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> StartMigrationJobAsync(StartMigrationJobRequest request, CallOptions options)

Start an already created migration job.

Parameters
NameDescription
requestStartMigrationJobRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

StartMigrationJobAsync(StartMigrationJobRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Operation> StartMigrationJobAsync(StartMigrationJobRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Start an already created migration job.

Parameters
NameDescription
requestStartMigrationJobRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

StopMigrationJob(StopMigrationJobRequest, CallOptions)

public virtual Operation StopMigrationJob(StopMigrationJobRequest request, CallOptions options)

Stops a running migration job.

Parameters
NameDescription
requestStopMigrationJobRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

StopMigrationJob(StopMigrationJobRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Operation StopMigrationJob(StopMigrationJobRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Stops a running migration job.

Parameters
NameDescription
requestStopMigrationJobRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

StopMigrationJobAsync(StopMigrationJobRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> StopMigrationJobAsync(StopMigrationJobRequest request, CallOptions options)

Stops a running migration job.

Parameters
NameDescription
requestStopMigrationJobRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

StopMigrationJobAsync(StopMigrationJobRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Operation> StopMigrationJobAsync(StopMigrationJobRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Stops a running migration job.

Parameters
NameDescription
requestStopMigrationJobRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

UpdateConnectionProfile(UpdateConnectionProfileRequest, CallOptions)

public virtual Operation UpdateConnectionProfile(UpdateConnectionProfileRequest request, CallOptions options)

Update the configuration of a single connection profile.

Parameters
NameDescription
requestUpdateConnectionProfileRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

UpdateConnectionProfile(UpdateConnectionProfileRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Operation UpdateConnectionProfile(UpdateConnectionProfileRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Update the configuration of a single connection profile.

Parameters
NameDescription
requestUpdateConnectionProfileRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

UpdateConnectionProfileAsync(UpdateConnectionProfileRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> UpdateConnectionProfileAsync(UpdateConnectionProfileRequest request, CallOptions options)

Update the configuration of a single connection profile.

Parameters
NameDescription
requestUpdateConnectionProfileRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

UpdateConnectionProfileAsync(UpdateConnectionProfileRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Operation> UpdateConnectionProfileAsync(UpdateConnectionProfileRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Update the configuration of a single connection profile.

Parameters
NameDescription
requestUpdateConnectionProfileRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

UpdateMigrationJob(UpdateMigrationJobRequest, CallOptions)

public virtual Operation UpdateMigrationJob(UpdateMigrationJobRequest request, CallOptions options)

Updates the parameters of a single migration job.

Parameters
NameDescription
requestUpdateMigrationJobRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

UpdateMigrationJob(UpdateMigrationJobRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Operation UpdateMigrationJob(UpdateMigrationJobRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Updates the parameters of a single migration job.

Parameters
NameDescription
requestUpdateMigrationJobRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

UpdateMigrationJobAsync(UpdateMigrationJobRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> UpdateMigrationJobAsync(UpdateMigrationJobRequest request, CallOptions options)

Updates the parameters of a single migration job.

Parameters
NameDescription
requestUpdateMigrationJobRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

UpdateMigrationJobAsync(UpdateMigrationJobRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Operation> UpdateMigrationJobAsync(UpdateMigrationJobRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Updates the parameters of a single migration job.

Parameters
NameDescription
requestUpdateMigrationJobRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

VerifyMigrationJob(VerifyMigrationJobRequest, CallOptions)

public virtual Operation VerifyMigrationJob(VerifyMigrationJobRequest request, CallOptions options)

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

Parameters
NameDescription
requestVerifyMigrationJobRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

VerifyMigrationJob(VerifyMigrationJobRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Operation VerifyMigrationJob(VerifyMigrationJobRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

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

Parameters
NameDescription
requestVerifyMigrationJobRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

VerifyMigrationJobAsync(VerifyMigrationJobRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> VerifyMigrationJobAsync(VerifyMigrationJobRequest request, CallOptions options)

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

Parameters
NameDescription
requestVerifyMigrationJobRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

VerifyMigrationJobAsync(VerifyMigrationJobRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Operation> VerifyMigrationJobAsync(VerifyMigrationJobRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

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

Parameters
NameDescription
requestVerifyMigrationJobRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineNullable<DateTime>

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.