Database Migration v1 API - Class DataMigrationServiceClientImpl (2.1.0)

public sealed class DataMigrationServiceClientImpl : DataMigrationServiceClient

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

DataMigrationService client wrapper implementation, for convenient use.

Inheritance

object > DataMigrationServiceClient > DataMigrationServiceClientImpl

Namespace

Google.Cloud.CloudDms.V1

Assembly

Google.Cloud.CloudDms.V1.dll

Remarks

Database Migration service

Constructors

DataMigrationServiceClientImpl(DataMigrationServiceClient, DataMigrationServiceSettings, ILogger)

public DataMigrationServiceClientImpl(DataMigrationService.DataMigrationServiceClient grpcClient, DataMigrationServiceSettings settings, ILogger logger)

Constructs a client wrapper for the DataMigrationService service, with the specified gRPC client and settings.

Parameters
NameDescription
grpcClientDataMigrationServiceDataMigrationServiceClient

The underlying gRPC client.

settingsDataMigrationServiceSettings

The base DataMigrationServiceSettings used within this client.

loggerILogger

Optional ILogger to use within this client.

Properties

ApplyConversionWorkspaceOperationsClient

public override OperationsClient ApplyConversionWorkspaceOperationsClient { get; }

The long-running operations client for ApplyConversionWorkspace.

Property Value
TypeDescription
OperationsClient
Overrides

CommitConversionWorkspaceOperationsClient

public override OperationsClient CommitConversionWorkspaceOperationsClient { get; }

The long-running operations client for CommitConversionWorkspace.

Property Value
TypeDescription
OperationsClient
Overrides

ConvertConversionWorkspaceOperationsClient

public override OperationsClient ConvertConversionWorkspaceOperationsClient { get; }

The long-running operations client for ConvertConversionWorkspace.

Property Value
TypeDescription
OperationsClient
Overrides

CreateConnectionProfileOperationsClient

public override OperationsClient CreateConnectionProfileOperationsClient { get; }

The long-running operations client for CreateConnectionProfile.

Property Value
TypeDescription
OperationsClient
Overrides

CreateConversionWorkspaceOperationsClient

public override OperationsClient CreateConversionWorkspaceOperationsClient { get; }

The long-running operations client for CreateConversionWorkspace.

Property Value
TypeDescription
OperationsClient
Overrides

CreateMigrationJobOperationsClient

public override OperationsClient CreateMigrationJobOperationsClient { get; }

The long-running operations client for CreateMigrationJob.

Property Value
TypeDescription
OperationsClient
Overrides

CreatePrivateConnectionOperationsClient

public override OperationsClient CreatePrivateConnectionOperationsClient { get; }

The long-running operations client for CreatePrivateConnection.

Property Value
TypeDescription
OperationsClient
Overrides

DeleteConnectionProfileOperationsClient

public override OperationsClient DeleteConnectionProfileOperationsClient { get; }

The long-running operations client for DeleteConnectionProfile.

Property Value
TypeDescription
OperationsClient
Overrides

DeleteConversionWorkspaceOperationsClient

public override OperationsClient DeleteConversionWorkspaceOperationsClient { get; }

The long-running operations client for DeleteConversionWorkspace.

Property Value
TypeDescription
OperationsClient
Overrides

DeleteMigrationJobOperationsClient

public override OperationsClient DeleteMigrationJobOperationsClient { get; }

The long-running operations client for DeleteMigrationJob.

Property Value
TypeDescription
OperationsClient
Overrides

DeletePrivateConnectionOperationsClient

public override OperationsClient DeletePrivateConnectionOperationsClient { get; }

The long-running operations client for DeletePrivateConnection.

Property Value
TypeDescription
OperationsClient
Overrides

GrpcClient

public override DataMigrationService.DataMigrationServiceClient GrpcClient { get; }

The underlying gRPC DataMigrationService client

Property Value
TypeDescription
DataMigrationServiceDataMigrationServiceClient
Overrides

IAMPolicyClient

public override IAMPolicyClient IAMPolicyClient { get; }

The IAMPolicyClient associated with this client.

Property Value
TypeDescription
IAMPolicyClient
Overrides

ImportMappingRulesOperationsClient

public override OperationsClient ImportMappingRulesOperationsClient { get; }

The long-running operations client for ImportMappingRules.

Property Value
TypeDescription
OperationsClient
Overrides

LocationsClient

public override LocationsClient LocationsClient { get; }

The LocationsClient associated with this client.

Property Value
TypeDescription
LocationsClient
Overrides

PromoteMigrationJobOperationsClient

public override OperationsClient PromoteMigrationJobOperationsClient { get; }

The long-running operations client for PromoteMigrationJob.

Property Value
TypeDescription
OperationsClient
Overrides

RestartMigrationJobOperationsClient

public override OperationsClient RestartMigrationJobOperationsClient { get; }

The long-running operations client for RestartMigrationJob.

Property Value
TypeDescription
OperationsClient
Overrides

ResumeMigrationJobOperationsClient

public override OperationsClient ResumeMigrationJobOperationsClient { get; }

The long-running operations client for ResumeMigrationJob.

Property Value
TypeDescription
OperationsClient
Overrides

RollbackConversionWorkspaceOperationsClient

public override OperationsClient RollbackConversionWorkspaceOperationsClient { get; }

The long-running operations client for RollbackConversionWorkspace.

Property Value
TypeDescription
OperationsClient
Overrides

SeedConversionWorkspaceOperationsClient

public override OperationsClient SeedConversionWorkspaceOperationsClient { get; }

The long-running operations client for SeedConversionWorkspace.

Property Value
TypeDescription
OperationsClient
Overrides

StartMigrationJobOperationsClient

public override OperationsClient StartMigrationJobOperationsClient { get; }

The long-running operations client for StartMigrationJob.

Property Value
TypeDescription
OperationsClient
Overrides

StopMigrationJobOperationsClient

public override OperationsClient StopMigrationJobOperationsClient { get; }

The long-running operations client for StopMigrationJob.

Property Value
TypeDescription
OperationsClient
Overrides

UpdateConnectionProfileOperationsClient

public override OperationsClient UpdateConnectionProfileOperationsClient { get; }

The long-running operations client for UpdateConnectionProfile.

Property Value
TypeDescription
OperationsClient
Overrides

UpdateConversionWorkspaceOperationsClient

public override OperationsClient UpdateConversionWorkspaceOperationsClient { get; }

The long-running operations client for UpdateConversionWorkspace.

Property Value
TypeDescription
OperationsClient
Overrides

UpdateMigrationJobOperationsClient

public override OperationsClient UpdateMigrationJobOperationsClient { get; }

The long-running operations client for UpdateMigrationJob.

Property Value
TypeDescription
OperationsClient
Overrides

VerifyMigrationJobOperationsClient

public override OperationsClient VerifyMigrationJobOperationsClient { get; }

The long-running operations client for VerifyMigrationJob.

Property Value
TypeDescription
OperationsClient
Overrides

Methods

ApplyConversionWorkspace(ApplyConversionWorkspaceRequest, CallSettings)

public override Operation<ConversionWorkspace, OperationMetadata> ApplyConversionWorkspace(ApplyConversionWorkspaceRequest request, CallSettings callSettings = null)

Applies draft tree onto a specific destination database.

Parameters
NameDescription
requestApplyConversionWorkspaceRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationConversionWorkspaceOperationMetadata

The RPC response.

Overrides

ApplyConversionWorkspaceAsync(ApplyConversionWorkspaceRequest, CallSettings)

public override Task<Operation<ConversionWorkspace, OperationMetadata>> ApplyConversionWorkspaceAsync(ApplyConversionWorkspaceRequest request, CallSettings callSettings = null)

Applies draft tree onto a specific destination database.

Parameters
NameDescription
requestApplyConversionWorkspaceRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationConversionWorkspaceOperationMetadata

A Task containing the RPC response.

Overrides

CommitConversionWorkspace(CommitConversionWorkspaceRequest, CallSettings)

public override Operation<ConversionWorkspace, OperationMetadata> CommitConversionWorkspace(CommitConversionWorkspaceRequest request, CallSettings callSettings = null)

Marks all the data in the conversion workspace as committed.

Parameters
NameDescription
requestCommitConversionWorkspaceRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationConversionWorkspaceOperationMetadata

The RPC response.

Overrides

CommitConversionWorkspaceAsync(CommitConversionWorkspaceRequest, CallSettings)

public override Task<Operation<ConversionWorkspace, OperationMetadata>> CommitConversionWorkspaceAsync(CommitConversionWorkspaceRequest request, CallSettings callSettings = null)

Marks all the data in the conversion workspace as committed.

Parameters
NameDescription
requestCommitConversionWorkspaceRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationConversionWorkspaceOperationMetadata

A Task containing the RPC response.

Overrides

ConvertConversionWorkspace(ConvertConversionWorkspaceRequest, CallSettings)

public override Operation<ConversionWorkspace, OperationMetadata> ConvertConversionWorkspace(ConvertConversionWorkspaceRequest request, CallSettings callSettings = null)

Creates a draft tree schema for the destination database.

Parameters
NameDescription
requestConvertConversionWorkspaceRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationConversionWorkspaceOperationMetadata

The RPC response.

Overrides

ConvertConversionWorkspaceAsync(ConvertConversionWorkspaceRequest, CallSettings)

public override Task<Operation<ConversionWorkspace, OperationMetadata>> ConvertConversionWorkspaceAsync(ConvertConversionWorkspaceRequest request, CallSettings callSettings = null)

Creates a draft tree schema for the destination database.

Parameters
NameDescription
requestConvertConversionWorkspaceRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationConversionWorkspaceOperationMetadata

A Task containing the RPC response.

Overrides

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

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationConnectionProfileOperationMetadata

The RPC response.

Overrides

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

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationConnectionProfileOperationMetadata

A Task containing the RPC response.

Overrides

CreateConversionWorkspace(CreateConversionWorkspaceRequest, CallSettings)

public override Operation<ConversionWorkspace, OperationMetadata> CreateConversionWorkspace(CreateConversionWorkspaceRequest request, CallSettings callSettings = null)

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

Parameters
NameDescription
requestCreateConversionWorkspaceRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationConversionWorkspaceOperationMetadata

The RPC response.

Overrides

CreateConversionWorkspaceAsync(CreateConversionWorkspaceRequest, CallSettings)

public override Task<Operation<ConversionWorkspace, OperationMetadata>> CreateConversionWorkspaceAsync(CreateConversionWorkspaceRequest request, CallSettings callSettings = null)

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

Parameters
NameDescription
requestCreateConversionWorkspaceRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationConversionWorkspaceOperationMetadata

A Task containing the RPC response.

Overrides

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

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationMigrationJobOperationMetadata

The RPC response.

Overrides

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

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationMigrationJobOperationMetadata

A Task containing the RPC response.

Overrides

CreatePrivateConnection(CreatePrivateConnectionRequest, CallSettings)

public override Operation<PrivateConnection, OperationMetadata> CreatePrivateConnection(CreatePrivateConnectionRequest request, CallSettings callSettings = null)

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

Parameters
NameDescription
requestCreatePrivateConnectionRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationPrivateConnectionOperationMetadata

The RPC response.

Overrides

CreatePrivateConnectionAsync(CreatePrivateConnectionRequest, CallSettings)

public override Task<Operation<PrivateConnection, OperationMetadata>> CreatePrivateConnectionAsync(CreatePrivateConnectionRequest request, CallSettings callSettings = null)

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

Parameters
NameDescription
requestCreatePrivateConnectionRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationPrivateConnectionOperationMetadata

A Task containing the RPC response.

Overrides

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

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationEmptyOperationMetadata

The RPC response.

Overrides

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

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationEmptyOperationMetadata

A Task containing the RPC response.

Overrides

DeleteConversionWorkspace(DeleteConversionWorkspaceRequest, CallSettings)

public override Operation<Empty, OperationMetadata> DeleteConversionWorkspace(DeleteConversionWorkspaceRequest request, CallSettings callSettings = null)

Deletes a single conversion workspace.

Parameters
NameDescription
requestDeleteConversionWorkspaceRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationEmptyOperationMetadata

The RPC response.

Overrides

DeleteConversionWorkspaceAsync(DeleteConversionWorkspaceRequest, CallSettings)

public override Task<Operation<Empty, OperationMetadata>> DeleteConversionWorkspaceAsync(DeleteConversionWorkspaceRequest request, CallSettings callSettings = null)

Deletes a single conversion workspace.

Parameters
NameDescription
requestDeleteConversionWorkspaceRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationEmptyOperationMetadata

A Task containing the RPC response.

Overrides

DeleteMigrationJob(DeleteMigrationJobRequest, CallSettings)

public override Operation<Empty, OperationMetadata> DeleteMigrationJob(DeleteMigrationJobRequest request, CallSettings callSettings = null)

Deletes a single migration job.

Parameters
NameDescription
requestDeleteMigrationJobRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationEmptyOperationMetadata

The RPC response.

Overrides

DeleteMigrationJobAsync(DeleteMigrationJobRequest, CallSettings)

public override Task<Operation<Empty, OperationMetadata>> DeleteMigrationJobAsync(DeleteMigrationJobRequest request, CallSettings callSettings = null)

Deletes a single migration job.

Parameters
NameDescription
requestDeleteMigrationJobRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationEmptyOperationMetadata

A Task containing the RPC response.

Overrides

DeletePrivateConnection(DeletePrivateConnectionRequest, CallSettings)

public override Operation<Empty, OperationMetadata> DeletePrivateConnection(DeletePrivateConnectionRequest request, CallSettings callSettings = null)

Deletes a single Database Migration Service private connection.

Parameters
NameDescription
requestDeletePrivateConnectionRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationEmptyOperationMetadata

The RPC response.

Overrides

DeletePrivateConnectionAsync(DeletePrivateConnectionRequest, CallSettings)

public override Task<Operation<Empty, OperationMetadata>> DeletePrivateConnectionAsync(DeletePrivateConnectionRequest request, CallSettings callSettings = null)

Deletes a single Database Migration Service private connection.

Parameters
NameDescription
requestDeletePrivateConnectionRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationEmptyOperationMetadata

A Task containing the RPC response.

Overrides

DescribeConversionWorkspaceRevisions(DescribeConversionWorkspaceRevisionsRequest, CallSettings)

public override DescribeConversionWorkspaceRevisionsResponse DescribeConversionWorkspaceRevisions(DescribeConversionWorkspaceRevisionsRequest request, CallSettings callSettings = null)

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

Parameters
NameDescription
requestDescribeConversionWorkspaceRevisionsRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
DescribeConversionWorkspaceRevisionsResponse

The RPC response.

Overrides

DescribeConversionWorkspaceRevisionsAsync(DescribeConversionWorkspaceRevisionsRequest, CallSettings)

public override Task<DescribeConversionWorkspaceRevisionsResponse> DescribeConversionWorkspaceRevisionsAsync(DescribeConversionWorkspaceRevisionsRequest request, CallSettings callSettings = null)

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

Parameters
NameDescription
requestDescribeConversionWorkspaceRevisionsRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskDescribeConversionWorkspaceRevisionsResponse

A Task containing the RPC response.

Overrides

DescribeDatabaseEntities(DescribeDatabaseEntitiesRequest, CallSettings)

public override PagedEnumerable<DescribeDatabaseEntitiesResponse, DatabaseEntity> DescribeDatabaseEntities(DescribeDatabaseEntitiesRequest request, CallSettings callSettings = null)

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

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerableDescribeDatabaseEntitiesResponseDatabaseEntity

A pageable sequence of DatabaseEntity resources.

Overrides

DescribeDatabaseEntitiesAsync(DescribeDatabaseEntitiesRequest, CallSettings)

public override PagedAsyncEnumerable<DescribeDatabaseEntitiesResponse, DatabaseEntity> DescribeDatabaseEntitiesAsync(DescribeDatabaseEntitiesRequest request, CallSettings callSettings = null)

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

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerableDescribeDatabaseEntitiesResponseDatabaseEntity

A pageable asynchronous sequence of DatabaseEntity resources.

Overrides

FetchStaticIps(FetchStaticIpsRequest, CallSettings)

public override PagedEnumerable<FetchStaticIpsResponse, string> FetchStaticIps(FetchStaticIpsRequest request, CallSettings callSettings = null)

Fetches a set of static IP addresses that need to be allowlisted by the customer when using the static-IP connectivity method.

Parameters
NameDescription
requestFetchStaticIpsRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerableFetchStaticIpsResponsestring

A pageable sequence of string resources.

Overrides

FetchStaticIpsAsync(FetchStaticIpsRequest, CallSettings)

public override PagedAsyncEnumerable<FetchStaticIpsResponse, string> FetchStaticIpsAsync(FetchStaticIpsRequest request, CallSettings callSettings = null)

Fetches a set of static IP addresses that need to be allowlisted by the customer when using the static-IP connectivity method.

Parameters
NameDescription
requestFetchStaticIpsRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerableFetchStaticIpsResponsestring

A pageable asynchronous sequence of string resources.

Overrides

GenerateSshScript(GenerateSshScriptRequest, CallSettings)

public override SshScript GenerateSshScript(GenerateSshScriptRequest request, CallSettings callSettings = null)

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

Parameters
NameDescription
requestGenerateSshScriptRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
SshScript

The RPC response.

Overrides

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

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskSshScript

A Task containing the RPC response.

Overrides

GetConnectionProfile(GetConnectionProfileRequest, CallSettings)

public override ConnectionProfile GetConnectionProfile(GetConnectionProfileRequest request, CallSettings callSettings = null)

Gets details of a single connection profile.

Parameters
NameDescription
requestGetConnectionProfileRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
ConnectionProfile

The RPC response.

Overrides

GetConnectionProfileAsync(GetConnectionProfileRequest, CallSettings)

public override Task<ConnectionProfile> GetConnectionProfileAsync(GetConnectionProfileRequest request, CallSettings callSettings = null)

Gets details of a single connection profile.

Parameters
NameDescription
requestGetConnectionProfileRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskConnectionProfile

A Task containing the RPC response.

Overrides

GetConversionWorkspace(GetConversionWorkspaceRequest, CallSettings)

public override ConversionWorkspace GetConversionWorkspace(GetConversionWorkspaceRequest request, CallSettings callSettings = null)

Gets details of a single conversion workspace.

Parameters
NameDescription
requestGetConversionWorkspaceRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
ConversionWorkspace

The RPC response.

Overrides

GetConversionWorkspaceAsync(GetConversionWorkspaceRequest, CallSettings)

public override Task<ConversionWorkspace> GetConversionWorkspaceAsync(GetConversionWorkspaceRequest request, CallSettings callSettings = null)

Gets details of a single conversion workspace.

Parameters
NameDescription
requestGetConversionWorkspaceRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskConversionWorkspace

A Task containing the RPC response.

Overrides

GetMigrationJob(GetMigrationJobRequest, CallSettings)

public override MigrationJob GetMigrationJob(GetMigrationJobRequest request, CallSettings callSettings = null)

Gets details of a single migration job.

Parameters
NameDescription
requestGetMigrationJobRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
MigrationJob

The RPC response.

Overrides

GetMigrationJobAsync(GetMigrationJobRequest, CallSettings)

public override Task<MigrationJob> GetMigrationJobAsync(GetMigrationJobRequest request, CallSettings callSettings = null)

Gets details of a single migration job.

Parameters
NameDescription
requestGetMigrationJobRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskMigrationJob

A Task containing the RPC response.

Overrides

GetPrivateConnection(GetPrivateConnectionRequest, CallSettings)

public override PrivateConnection GetPrivateConnection(GetPrivateConnectionRequest request, CallSettings callSettings = null)

Gets details of a single private connection.

Parameters
NameDescription
requestGetPrivateConnectionRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PrivateConnection

The RPC response.

Overrides

GetPrivateConnectionAsync(GetPrivateConnectionRequest, CallSettings)

public override Task<PrivateConnection> GetPrivateConnectionAsync(GetPrivateConnectionRequest request, CallSettings callSettings = null)

Gets details of a single private connection.

Parameters
NameDescription
requestGetPrivateConnectionRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskPrivateConnection

A Task containing the RPC response.

Overrides

ImportMappingRules(ImportMappingRulesRequest, CallSettings)

public override Operation<ConversionWorkspace, OperationMetadata> ImportMappingRules(ImportMappingRulesRequest request, CallSettings callSettings = null)

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

Parameters
NameDescription
requestImportMappingRulesRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationConversionWorkspaceOperationMetadata

The RPC response.

Overrides

ImportMappingRulesAsync(ImportMappingRulesRequest, CallSettings)

public override Task<Operation<ConversionWorkspace, OperationMetadata>> ImportMappingRulesAsync(ImportMappingRulesRequest request, CallSettings callSettings = null)

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

Parameters
NameDescription
requestImportMappingRulesRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationConversionWorkspaceOperationMetadata

A Task containing the RPC response.

Overrides

ListConnectionProfiles(ListConnectionProfilesRequest, CallSettings)

public override PagedEnumerable<ListConnectionProfilesResponse, ConnectionProfile> ListConnectionProfiles(ListConnectionProfilesRequest request, CallSettings callSettings = null)

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

Parameters
NameDescription
requestListConnectionProfilesRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerableListConnectionProfilesResponseConnectionProfile

A pageable sequence of ConnectionProfile resources.

Overrides

ListConnectionProfilesAsync(ListConnectionProfilesRequest, CallSettings)

public override PagedAsyncEnumerable<ListConnectionProfilesResponse, ConnectionProfile> ListConnectionProfilesAsync(ListConnectionProfilesRequest request, CallSettings callSettings = null)

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

Parameters
NameDescription
requestListConnectionProfilesRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerableListConnectionProfilesResponseConnectionProfile

A pageable asynchronous sequence of ConnectionProfile resources.

Overrides

ListConversionWorkspaces(ListConversionWorkspacesRequest, CallSettings)

public override PagedEnumerable<ListConversionWorkspacesResponse, ConversionWorkspace> ListConversionWorkspaces(ListConversionWorkspacesRequest request, CallSettings callSettings = null)

Lists conversion workspaces in a given project and location.

Parameters
NameDescription
requestListConversionWorkspacesRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerableListConversionWorkspacesResponseConversionWorkspace

A pageable sequence of ConversionWorkspace resources.

Overrides

ListConversionWorkspacesAsync(ListConversionWorkspacesRequest, CallSettings)

public override PagedAsyncEnumerable<ListConversionWorkspacesResponse, ConversionWorkspace> ListConversionWorkspacesAsync(ListConversionWorkspacesRequest request, CallSettings callSettings = null)

Lists conversion workspaces in a given project and location.

Parameters
NameDescription
requestListConversionWorkspacesRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerableListConversionWorkspacesResponseConversionWorkspace

A pageable asynchronous sequence of ConversionWorkspace resources.

Overrides

ListMigrationJobs(ListMigrationJobsRequest, CallSettings)

public override PagedEnumerable<ListMigrationJobsResponse, MigrationJob> ListMigrationJobs(ListMigrationJobsRequest request, CallSettings callSettings = null)

Lists migration jobs in a given project and location.

Parameters
NameDescription
requestListMigrationJobsRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerableListMigrationJobsResponseMigrationJob

A pageable sequence of MigrationJob resources.

Overrides

ListMigrationJobsAsync(ListMigrationJobsRequest, CallSettings)

public override PagedAsyncEnumerable<ListMigrationJobsResponse, MigrationJob> ListMigrationJobsAsync(ListMigrationJobsRequest request, CallSettings callSettings = null)

Lists migration jobs in a given project and location.

Parameters
NameDescription
requestListMigrationJobsRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerableListMigrationJobsResponseMigrationJob

A pageable asynchronous sequence of MigrationJob resources.

Overrides

ListPrivateConnections(ListPrivateConnectionsRequest, CallSettings)

public override PagedEnumerable<ListPrivateConnectionsResponse, PrivateConnection> ListPrivateConnections(ListPrivateConnectionsRequest request, CallSettings callSettings = null)

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

Parameters
NameDescription
requestListPrivateConnectionsRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerableListPrivateConnectionsResponsePrivateConnection

A pageable sequence of PrivateConnection resources.

Overrides

ListPrivateConnectionsAsync(ListPrivateConnectionsRequest, CallSettings)

public override PagedAsyncEnumerable<ListPrivateConnectionsResponse, PrivateConnection> ListPrivateConnectionsAsync(ListPrivateConnectionsRequest request, CallSettings callSettings = null)

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

Parameters
NameDescription
requestListPrivateConnectionsRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerableListPrivateConnectionsResponsePrivateConnection

A pageable asynchronous sequence of PrivateConnection resources.

Overrides

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

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationMigrationJobOperationMetadata

The RPC response.

Overrides

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

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationMigrationJobOperationMetadata

A Task containing the RPC response.

Overrides

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

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationMigrationJobOperationMetadata

The RPC response.

Overrides

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

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationMigrationJobOperationMetadata

A Task containing the RPC response.

Overrides

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

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationMigrationJobOperationMetadata

The RPC response.

Overrides

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

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationMigrationJobOperationMetadata

A Task containing the RPC response.

Overrides

RollbackConversionWorkspace(RollbackConversionWorkspaceRequest, CallSettings)

public override Operation<ConversionWorkspace, OperationMetadata> RollbackConversionWorkspace(RollbackConversionWorkspaceRequest request, CallSettings callSettings = null)

Rolls back a conversion workspace to the last committed snapshot.

Parameters
NameDescription
requestRollbackConversionWorkspaceRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationConversionWorkspaceOperationMetadata

The RPC response.

Overrides

RollbackConversionWorkspaceAsync(RollbackConversionWorkspaceRequest, CallSettings)

public override Task<Operation<ConversionWorkspace, OperationMetadata>> RollbackConversionWorkspaceAsync(RollbackConversionWorkspaceRequest request, CallSettings callSettings = null)

Rolls back a conversion workspace to the last committed snapshot.

Parameters
NameDescription
requestRollbackConversionWorkspaceRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationConversionWorkspaceOperationMetadata

A Task containing the RPC response.

Overrides

SearchBackgroundJobs(SearchBackgroundJobsRequest, CallSettings)

public override SearchBackgroundJobsResponse SearchBackgroundJobs(SearchBackgroundJobsRequest request, CallSettings callSettings = null)

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

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
SearchBackgroundJobsResponse

The RPC response.

Overrides

SearchBackgroundJobsAsync(SearchBackgroundJobsRequest, CallSettings)

public override Task<SearchBackgroundJobsResponse> SearchBackgroundJobsAsync(SearchBackgroundJobsRequest request, CallSettings callSettings = null)

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

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskSearchBackgroundJobsResponse

A Task containing the RPC response.

Overrides

SeedConversionWorkspace(SeedConversionWorkspaceRequest, CallSettings)

public override Operation<ConversionWorkspace, OperationMetadata> SeedConversionWorkspace(SeedConversionWorkspaceRequest request, CallSettings callSettings = null)

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

Parameters
NameDescription
requestSeedConversionWorkspaceRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationConversionWorkspaceOperationMetadata

The RPC response.

Overrides

SeedConversionWorkspaceAsync(SeedConversionWorkspaceRequest, CallSettings)

public override Task<Operation<ConversionWorkspace, OperationMetadata>> SeedConversionWorkspaceAsync(SeedConversionWorkspaceRequest request, CallSettings callSettings = null)

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

Parameters
NameDescription
requestSeedConversionWorkspaceRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationConversionWorkspaceOperationMetadata

A Task containing the RPC response.

Overrides

StartMigrationJob(StartMigrationJobRequest, CallSettings)

public override Operation<MigrationJob, OperationMetadata> StartMigrationJob(StartMigrationJobRequest request, CallSettings callSettings = null)

Start an already created migration job.

Parameters
NameDescription
requestStartMigrationJobRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationMigrationJobOperationMetadata

The RPC response.

Overrides

StartMigrationJobAsync(StartMigrationJobRequest, CallSettings)

public override Task<Operation<MigrationJob, OperationMetadata>> StartMigrationJobAsync(StartMigrationJobRequest request, CallSettings callSettings = null)

Start an already created migration job.

Parameters
NameDescription
requestStartMigrationJobRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationMigrationJobOperationMetadata

A Task containing the RPC response.

Overrides

StopMigrationJob(StopMigrationJobRequest, CallSettings)

public override Operation<MigrationJob, OperationMetadata> StopMigrationJob(StopMigrationJobRequest request, CallSettings callSettings = null)

Stops a running migration job.

Parameters
NameDescription
requestStopMigrationJobRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationMigrationJobOperationMetadata

The RPC response.

Overrides

StopMigrationJobAsync(StopMigrationJobRequest, CallSettings)

public override Task<Operation<MigrationJob, OperationMetadata>> StopMigrationJobAsync(StopMigrationJobRequest request, CallSettings callSettings = null)

Stops a running migration job.

Parameters
NameDescription
requestStopMigrationJobRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationMigrationJobOperationMetadata

A Task containing the RPC response.

Overrides

UpdateConnectionProfile(UpdateConnectionProfileRequest, CallSettings)

public override Operation<ConnectionProfile, OperationMetadata> UpdateConnectionProfile(UpdateConnectionProfileRequest request, CallSettings callSettings = null)

Update the configuration of a single connection profile.

Parameters
NameDescription
requestUpdateConnectionProfileRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationConnectionProfileOperationMetadata

The RPC response.

Overrides

UpdateConnectionProfileAsync(UpdateConnectionProfileRequest, CallSettings)

public override Task<Operation<ConnectionProfile, OperationMetadata>> UpdateConnectionProfileAsync(UpdateConnectionProfileRequest request, CallSettings callSettings = null)

Update the configuration of a single connection profile.

Parameters
NameDescription
requestUpdateConnectionProfileRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationConnectionProfileOperationMetadata

A Task containing the RPC response.

Overrides

UpdateConversionWorkspace(UpdateConversionWorkspaceRequest, CallSettings)

public override Operation<ConversionWorkspace, OperationMetadata> UpdateConversionWorkspace(UpdateConversionWorkspaceRequest request, CallSettings callSettings = null)

Updates the parameters of a single conversion workspace.

Parameters
NameDescription
requestUpdateConversionWorkspaceRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationConversionWorkspaceOperationMetadata

The RPC response.

Overrides

UpdateConversionWorkspaceAsync(UpdateConversionWorkspaceRequest, CallSettings)

public override Task<Operation<ConversionWorkspace, OperationMetadata>> UpdateConversionWorkspaceAsync(UpdateConversionWorkspaceRequest request, CallSettings callSettings = null)

Updates the parameters of a single conversion workspace.

Parameters
NameDescription
requestUpdateConversionWorkspaceRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationConversionWorkspaceOperationMetadata

A Task containing the RPC response.

Overrides

UpdateMigrationJob(UpdateMigrationJobRequest, CallSettings)

public override Operation<MigrationJob, OperationMetadata> UpdateMigrationJob(UpdateMigrationJobRequest request, CallSettings callSettings = null)

Updates the parameters of a single migration job.

Parameters
NameDescription
requestUpdateMigrationJobRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationMigrationJobOperationMetadata

The RPC response.

Overrides

UpdateMigrationJobAsync(UpdateMigrationJobRequest, CallSettings)

public override Task<Operation<MigrationJob, OperationMetadata>> UpdateMigrationJobAsync(UpdateMigrationJobRequest request, CallSettings callSettings = null)

Updates the parameters of a single migration job.

Parameters
NameDescription
requestUpdateMigrationJobRequest

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationMigrationJobOperationMetadata

A Task containing the RPC response.

Overrides

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

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationMigrationJobOperationMetadata

The RPC response.

Overrides

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

The request object containing all of the parameters for the API call.

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationMigrationJobOperationMetadata

A Task containing the RPC response.

Overrides