public sealed class DataMigrationServiceClientImpl : DataMigrationServiceClient
DataMigrationService client wrapper implementation, for convenient use.
Namespace
Google.Cloud.CloudDms.V1Assembly
Google.Cloud.CloudDms.V1.dll
Remarks
Database Migration service
Constructors
DataMigrationServiceClientImpl(DataMigrationService.DataMigrationServiceClient, DataMigrationServiceSettings)
public DataMigrationServiceClientImpl(DataMigrationService.DataMigrationServiceClient grpcClient, DataMigrationServiceSettings settings)
Constructs a client wrapper for the DataMigrationService service, with the specified gRPC client and settings.
Parameters | |
---|---|
Name | Description |
grpcClient | DataMigrationService.DataMigrationServiceClient The underlying gRPC client. |
settings | DataMigrationServiceSettings The base DataMigrationServiceSettings used within this client. |
Properties
CreateConnectionProfileOperationsClient
public override OperationsClient CreateConnectionProfileOperationsClient { get; }
The long-running operations client for CreateConnectionProfile
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
CreateMigrationJobOperationsClient
public override OperationsClient CreateMigrationJobOperationsClient { get; }
The long-running operations client for CreateMigrationJob
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
DeleteConnectionProfileOperationsClient
public override OperationsClient DeleteConnectionProfileOperationsClient { get; }
The long-running operations client for DeleteConnectionProfile
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
DeleteMigrationJobOperationsClient
public override OperationsClient DeleteMigrationJobOperationsClient { get; }
The long-running operations client for DeleteMigrationJob
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
GrpcClient
public override DataMigrationService.DataMigrationServiceClient GrpcClient { get; }
The underlying gRPC DataMigrationService client
Property Value | |
---|---|
Type | Description |
DataMigrationService.DataMigrationServiceClient |
PromoteMigrationJobOperationsClient
public override OperationsClient PromoteMigrationJobOperationsClient { get; }
The long-running operations client for PromoteMigrationJob
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
RestartMigrationJobOperationsClient
public override OperationsClient RestartMigrationJobOperationsClient { get; }
The long-running operations client for RestartMigrationJob
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
ResumeMigrationJobOperationsClient
public override OperationsClient ResumeMigrationJobOperationsClient { get; }
The long-running operations client for ResumeMigrationJob
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
StartMigrationJobOperationsClient
public override OperationsClient StartMigrationJobOperationsClient { get; }
The long-running operations client for StartMigrationJob
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
StopMigrationJobOperationsClient
public override OperationsClient StopMigrationJobOperationsClient { get; }
The long-running operations client for StopMigrationJob
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
UpdateConnectionProfileOperationsClient
public override OperationsClient UpdateConnectionProfileOperationsClient { get; }
The long-running operations client for UpdateConnectionProfile
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
UpdateMigrationJobOperationsClient
public override OperationsClient UpdateMigrationJobOperationsClient { get; }
The long-running operations client for UpdateMigrationJob
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
VerifyMigrationJobOperationsClient
public override OperationsClient VerifyMigrationJobOperationsClient { get; }
The long-running operations client for VerifyMigrationJob
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
Methods
CreateConnectionProfile(CreateConnectionProfileRequest, CallSettings)
public override Operation<ConnectionProfile, OperationMetadata> CreateConnectionProfile(CreateConnectionProfileRequest request, CallSettings callSettings = null)
Creates a new connection profile in a given project and location.
Parameters | |
---|---|
Name | Description |
request | CreateConnectionProfileRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Operation<ConnectionProfile, OperationMetadata> | The RPC response. |
CreateConnectionProfileAsync(CreateConnectionProfileRequest, CallSettings)
public override Task<Operation<ConnectionProfile, OperationMetadata>> CreateConnectionProfileAsync(CreateConnectionProfileRequest request, CallSettings callSettings = null)
Creates a new connection profile in a given project and location.
Parameters | |
---|---|
Name | Description |
request | CreateConnectionProfileRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task<Operation<ConnectionProfile, OperationMetadata>> | A Task containing the RPC response. |
CreateMigrationJob(CreateMigrationJobRequest, CallSettings)
public override Operation<MigrationJob, OperationMetadata> CreateMigrationJob(CreateMigrationJobRequest request, CallSettings callSettings = null)
Creates a new migration job in a given project and location.
Parameters | |
---|---|
Name | Description |
request | CreateMigrationJobRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Operation<MigrationJob, OperationMetadata> | The RPC response. |
CreateMigrationJobAsync(CreateMigrationJobRequest, CallSettings)
public override Task<Operation<MigrationJob, OperationMetadata>> CreateMigrationJobAsync(CreateMigrationJobRequest request, CallSettings callSettings = null)
Creates a new migration job in a given project and location.
Parameters | |
---|---|
Name | Description |
request | CreateMigrationJobRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task<Operation<MigrationJob, OperationMetadata>> | A Task containing the RPC response. |
DeleteConnectionProfile(DeleteConnectionProfileRequest, CallSettings)
public override Operation<Empty, OperationMetadata> DeleteConnectionProfile(DeleteConnectionProfileRequest request, CallSettings callSettings = null)
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 object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Operation<Empty, OperationMetadata> | The RPC response. |
DeleteConnectionProfileAsync(DeleteConnectionProfileRequest, CallSettings)
public override Task<Operation<Empty, OperationMetadata>> DeleteConnectionProfileAsync(DeleteConnectionProfileRequest request, CallSettings callSettings = null)
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 object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task<Operation<Empty, OperationMetadata>> | A Task containing the RPC response. |
DeleteMigrationJob(DeleteMigrationJobRequest, CallSettings)
public override Operation<Empty, OperationMetadata> DeleteMigrationJob(DeleteMigrationJobRequest request, CallSettings callSettings = null)
Deletes a single migration job.
Parameters | |
---|---|
Name | Description |
request | DeleteMigrationJobRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Operation<Empty, OperationMetadata> | The RPC response. |
DeleteMigrationJobAsync(DeleteMigrationJobRequest, CallSettings)
public override Task<Operation<Empty, OperationMetadata>> DeleteMigrationJobAsync(DeleteMigrationJobRequest request, CallSettings callSettings = null)
Deletes a single migration job.
Parameters | |
---|---|
Name | Description |
request | DeleteMigrationJobRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task<Operation<Empty, OperationMetadata>> | A Task containing the RPC response. |
GenerateSshScript(GenerateSshScriptRequest, CallSettings)
public override SshScript GenerateSshScript(GenerateSshScriptRequest request, CallSettings callSettings = null)
Generate a SSH configuration script to configure the reverse SSH connectivity.
Parameters | |
---|---|
Name | Description |
request | GenerateSshScriptRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
SshScript | The RPC response. |
GenerateSshScriptAsync(GenerateSshScriptRequest, CallSettings)
public override Task<SshScript> GenerateSshScriptAsync(GenerateSshScriptRequest request, CallSettings callSettings = null)
Generate a SSH configuration script to configure the reverse SSH connectivity.
Parameters | |
---|---|
Name | Description |
request | GenerateSshScriptRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task<SshScript> | A Task containing the RPC response. |
GetConnectionProfile(GetConnectionProfileRequest, CallSettings)
public override ConnectionProfile GetConnectionProfile(GetConnectionProfileRequest request, CallSettings callSettings = null)
Gets details of a single connection profile.
Parameters | |
---|---|
Name | Description |
request | GetConnectionProfileRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
ConnectionProfile | The RPC response. |
GetConnectionProfileAsync(GetConnectionProfileRequest, CallSettings)
public override Task<ConnectionProfile> GetConnectionProfileAsync(GetConnectionProfileRequest request, CallSettings callSettings = null)
Gets details of a single connection profile.
Parameters | |
---|---|
Name | Description |
request | GetConnectionProfileRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task<ConnectionProfile> | A Task containing the RPC response. |
GetMigrationJob(GetMigrationJobRequest, CallSettings)
public override MigrationJob GetMigrationJob(GetMigrationJobRequest request, CallSettings callSettings = null)
Gets details of a single migration job.
Parameters | |
---|---|
Name | Description |
request | GetMigrationJobRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
MigrationJob | The RPC response. |
GetMigrationJobAsync(GetMigrationJobRequest, CallSettings)
public override Task<MigrationJob> GetMigrationJobAsync(GetMigrationJobRequest request, CallSettings callSettings = null)
Gets details of a single migration job.
Parameters | |
---|---|
Name | Description |
request | GetMigrationJobRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task<MigrationJob> | A Task containing the RPC response. |
ListConnectionProfiles(ListConnectionProfilesRequest, CallSettings)
public override PagedEnumerable<ListConnectionProfilesResponse, ConnectionProfile> ListConnectionProfiles(ListConnectionProfilesRequest request, CallSettings callSettings = null)
Retrieve a list of all connection profiles in a given project and location.
Parameters | |
---|---|
Name | Description |
request | ListConnectionProfilesRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedEnumerable<ListConnectionProfilesResponse, ConnectionProfile> | A pageable sequence of ConnectionProfile resources. |
ListConnectionProfilesAsync(ListConnectionProfilesRequest, CallSettings)
public override PagedAsyncEnumerable<ListConnectionProfilesResponse, ConnectionProfile> ListConnectionProfilesAsync(ListConnectionProfilesRequest request, CallSettings callSettings = null)
Retrieve a list of all connection profiles in a given project and location.
Parameters | |
---|---|
Name | Description |
request | ListConnectionProfilesRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedAsyncEnumerable<ListConnectionProfilesResponse, ConnectionProfile> | A pageable asynchronous sequence of ConnectionProfile resources. |
ListMigrationJobs(ListMigrationJobsRequest, CallSettings)
public override PagedEnumerable<ListMigrationJobsResponse, MigrationJob> ListMigrationJobs(ListMigrationJobsRequest request, CallSettings callSettings = null)
Lists migration jobs in a given project and location.
Parameters | |
---|---|
Name | Description |
request | ListMigrationJobsRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedEnumerable<ListMigrationJobsResponse, MigrationJob> | A pageable sequence of MigrationJob resources. |
ListMigrationJobsAsync(ListMigrationJobsRequest, CallSettings)
public override PagedAsyncEnumerable<ListMigrationJobsResponse, MigrationJob> ListMigrationJobsAsync(ListMigrationJobsRequest request, CallSettings callSettings = null)
Lists migration jobs in a given project and location.
Parameters | |
---|---|
Name | Description |
request | ListMigrationJobsRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
PagedAsyncEnumerable<ListMigrationJobsResponse, MigrationJob> | A pageable asynchronous sequence of MigrationJob resources. |
PromoteMigrationJob(PromoteMigrationJobRequest, CallSettings)
public override Operation<MigrationJob, OperationMetadata> PromoteMigrationJob(PromoteMigrationJobRequest request, CallSettings callSettings = null)
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 object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Operation<MigrationJob, OperationMetadata> | The RPC response. |
PromoteMigrationJobAsync(PromoteMigrationJobRequest, CallSettings)
public override Task<Operation<MigrationJob, OperationMetadata>> PromoteMigrationJobAsync(PromoteMigrationJobRequest request, CallSettings callSettings = null)
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 object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task<Operation<MigrationJob, OperationMetadata>> | A Task containing the RPC response. |
RestartMigrationJob(RestartMigrationJobRequest, CallSettings)
public override Operation<MigrationJob, OperationMetadata> RestartMigrationJob(RestartMigrationJobRequest request, CallSettings callSettings = null)
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 object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Operation<MigrationJob, OperationMetadata> | The RPC response. |
RestartMigrationJobAsync(RestartMigrationJobRequest, CallSettings)
public override Task<Operation<MigrationJob, OperationMetadata>> RestartMigrationJobAsync(RestartMigrationJobRequest request, CallSettings callSettings = null)
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 object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task<Operation<MigrationJob, OperationMetadata>> | A Task containing the RPC response. |
ResumeMigrationJob(ResumeMigrationJobRequest, CallSettings)
public override Operation<MigrationJob, OperationMetadata> ResumeMigrationJob(ResumeMigrationJobRequest request, CallSettings callSettings = null)
Resume a migration job that is currently stopped and is resumable (was stopped during CDC phase).
Parameters | |
---|---|
Name | Description |
request | ResumeMigrationJobRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Operation<MigrationJob, OperationMetadata> | The RPC response. |
ResumeMigrationJobAsync(ResumeMigrationJobRequest, CallSettings)
public override Task<Operation<MigrationJob, OperationMetadata>> ResumeMigrationJobAsync(ResumeMigrationJobRequest request, CallSettings callSettings = null)
Resume a migration job that is currently stopped and is resumable (was stopped during CDC phase).
Parameters | |
---|---|
Name | Description |
request | ResumeMigrationJobRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task<Operation<MigrationJob, OperationMetadata>> | A Task containing the RPC response. |
StartMigrationJob(StartMigrationJobRequest, CallSettings)
public override Operation<MigrationJob, OperationMetadata> StartMigrationJob(StartMigrationJobRequest request, CallSettings callSettings = null)
Start an already created migration job.
Parameters | |
---|---|
Name | Description |
request | StartMigrationJobRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Operation<MigrationJob, OperationMetadata> | The RPC response. |
StartMigrationJobAsync(StartMigrationJobRequest, CallSettings)
public override Task<Operation<MigrationJob, OperationMetadata>> StartMigrationJobAsync(StartMigrationJobRequest request, CallSettings callSettings = null)
Start an already created migration job.
Parameters | |
---|---|
Name | Description |
request | StartMigrationJobRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task<Operation<MigrationJob, OperationMetadata>> | A Task containing the RPC response. |
StopMigrationJob(StopMigrationJobRequest, CallSettings)
public override Operation<MigrationJob, OperationMetadata> StopMigrationJob(StopMigrationJobRequest request, CallSettings callSettings = null)
Stops a running migration job.
Parameters | |
---|---|
Name | Description |
request | StopMigrationJobRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Operation<MigrationJob, OperationMetadata> | The RPC response. |
StopMigrationJobAsync(StopMigrationJobRequest, CallSettings)
public override Task<Operation<MigrationJob, OperationMetadata>> StopMigrationJobAsync(StopMigrationJobRequest request, CallSettings callSettings = null)
Stops a running migration job.
Parameters | |
---|---|
Name | Description |
request | StopMigrationJobRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task<Operation<MigrationJob, OperationMetadata>> | A Task containing the RPC response. |
UpdateConnectionProfile(UpdateConnectionProfileRequest, CallSettings)
public override Operation<ConnectionProfile, OperationMetadata> UpdateConnectionProfile(UpdateConnectionProfileRequest request, CallSettings callSettings = null)
Update the configuration of a single connection profile.
Parameters | |
---|---|
Name | Description |
request | UpdateConnectionProfileRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Operation<ConnectionProfile, OperationMetadata> | The RPC response. |
UpdateConnectionProfileAsync(UpdateConnectionProfileRequest, CallSettings)
public override Task<Operation<ConnectionProfile, OperationMetadata>> UpdateConnectionProfileAsync(UpdateConnectionProfileRequest request, CallSettings callSettings = null)
Update the configuration of a single connection profile.
Parameters | |
---|---|
Name | Description |
request | UpdateConnectionProfileRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task<Operation<ConnectionProfile, OperationMetadata>> | A Task containing the RPC response. |
UpdateMigrationJob(UpdateMigrationJobRequest, CallSettings)
public override Operation<MigrationJob, OperationMetadata> UpdateMigrationJob(UpdateMigrationJobRequest request, CallSettings callSettings = null)
Updates the parameters of a single migration job.
Parameters | |
---|---|
Name | Description |
request | UpdateMigrationJobRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Operation<MigrationJob, OperationMetadata> | The RPC response. |
UpdateMigrationJobAsync(UpdateMigrationJobRequest, CallSettings)
public override Task<Operation<MigrationJob, OperationMetadata>> UpdateMigrationJobAsync(UpdateMigrationJobRequest request, CallSettings callSettings = null)
Updates the parameters of a single migration job.
Parameters | |
---|---|
Name | Description |
request | UpdateMigrationJobRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task<Operation<MigrationJob, OperationMetadata>> | A Task containing the RPC response. |
VerifyMigrationJob(VerifyMigrationJobRequest, CallSettings)
public override Operation<MigrationJob, OperationMetadata> VerifyMigrationJob(VerifyMigrationJobRequest request, CallSettings callSettings = null)
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 object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Operation<MigrationJob, OperationMetadata> | The RPC response. |
VerifyMigrationJobAsync(VerifyMigrationJobRequest, CallSettings)
public override Task<Operation<MigrationJob, OperationMetadata>> VerifyMigrationJobAsync(VerifyMigrationJobRequest request, CallSettings callSettings = null)
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 object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Task<Operation<MigrationJob, OperationMetadata>> | A Task containing the RPC response. |