public sealed class DataMigrationServiceClientImpl : DataMigrationServiceClientReference documentation and code samples for the Database Migration v1 API class DataMigrationServiceClientImpl.
DataMigrationService client wrapper implementation, for convenient use.
Namespace
Google.Cloud.CloudDms.V1Assembly
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 | |
|---|---|
| Name | Description |
grpcClient | DataMigrationServiceDataMigrationServiceClientThe underlying gRPC client. |
settings | DataMigrationServiceSettingsThe base DataMigrationServiceSettings used within this client. |
logger | ILoggerOptional ILogger to use within this client. |
Properties
ApplyConversionWorkspaceOperationsClient
public override OperationsClient ApplyConversionWorkspaceOperationsClient { get; }The long-running operations client for ApplyConversionWorkspace.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
CommitConversionWorkspaceOperationsClient
public override OperationsClient CommitConversionWorkspaceOperationsClient { get; }The long-running operations client for CommitConversionWorkspace.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
ConvertConversionWorkspaceOperationsClient
public override OperationsClient ConvertConversionWorkspaceOperationsClient { get; }The long-running operations client for ConvertConversionWorkspace.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
CreateConnectionProfileOperationsClient
public override OperationsClient CreateConnectionProfileOperationsClient { get; }The long-running operations client for CreateConnectionProfile.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
CreateConversionWorkspaceOperationsClient
public override OperationsClient CreateConversionWorkspaceOperationsClient { get; }The long-running operations client for CreateConversionWorkspace.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
CreateMigrationJobOperationsClient
public override OperationsClient CreateMigrationJobOperationsClient { get; }The long-running operations client for CreateMigrationJob.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
CreatePrivateConnectionOperationsClient
public override OperationsClient CreatePrivateConnectionOperationsClient { get; }The long-running operations client for CreatePrivateConnection.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
DeleteConnectionProfileOperationsClient
public override OperationsClient DeleteConnectionProfileOperationsClient { get; }The long-running operations client for DeleteConnectionProfile.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
DeleteConversionWorkspaceOperationsClient
public override OperationsClient DeleteConversionWorkspaceOperationsClient { get; }The long-running operations client for DeleteConversionWorkspace.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
DeleteMigrationJobOperationsClient
public override OperationsClient DeleteMigrationJobOperationsClient { get; }The long-running operations client for DeleteMigrationJob.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
DeletePrivateConnectionOperationsClient
public override OperationsClient DeletePrivateConnectionOperationsClient { get; }The long-running operations client for DeletePrivateConnection.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
GrpcClient
public override DataMigrationService.DataMigrationServiceClient GrpcClient { get; }The underlying gRPC DataMigrationService client
| Property Value | |
|---|---|
| Type | Description |
DataMigrationServiceDataMigrationServiceClient | |
IAMPolicyClient
public override IAMPolicyClient IAMPolicyClient { get; }The IAMPolicyClient associated with this client.
| Property Value | |
|---|---|
| Type | Description |
IAMPolicyClient | |
ImportMappingRulesOperationsClient
public override OperationsClient ImportMappingRulesOperationsClient { get; }The long-running operations client for ImportMappingRules.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
LocationsClient
public override LocationsClient LocationsClient { get; }The LocationsClient associated with this client.
| Property Value | |
|---|---|
| Type | Description |
LocationsClient | |
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 | |
RollbackConversionWorkspaceOperationsClient
public override OperationsClient RollbackConversionWorkspaceOperationsClient { get; }The long-running operations client for RollbackConversionWorkspace.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
SeedConversionWorkspaceOperationsClient
public override OperationsClient SeedConversionWorkspaceOperationsClient { get; }The long-running operations client for SeedConversionWorkspace.
| 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 | |
UpdateConversionWorkspaceOperationsClient
public override OperationsClient UpdateConversionWorkspaceOperationsClient { get; }The long-running operations client for UpdateConversionWorkspace.
| 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
ApplyConversionWorkspace(ApplyConversionWorkspaceRequest, CallSettings)
public override Operation<ConversionWorkspace, OperationMetadata> ApplyConversionWorkspace(ApplyConversionWorkspaceRequest request, CallSettings callSettings = null)Applies draft tree onto a specific destination database.
| Parameters | |
|---|---|
| Name | Description |
request | ApplyConversionWorkspaceRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationConversionWorkspaceOperationMetadata | The RPC response. |
ApplyConversionWorkspaceAsync(ApplyConversionWorkspaceRequest, CallSettings)
public override Task<Operation<ConversionWorkspace, OperationMetadata>> ApplyConversionWorkspaceAsync(ApplyConversionWorkspaceRequest request, CallSettings callSettings = null)Applies draft tree onto a specific destination database.
| Parameters | |
|---|---|
| Name | Description |
request | ApplyConversionWorkspaceRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationConversionWorkspaceOperationMetadata | A Task containing the RPC response. |
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 | |
|---|---|
| Name | Description |
request | CommitConversionWorkspaceRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationConversionWorkspaceOperationMetadata | The RPC response. |
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 | |
|---|---|
| Name | Description |
request | CommitConversionWorkspaceRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationConversionWorkspaceOperationMetadata | A Task containing the RPC response. |
ConvertConversionWorkspace(ConvertConversionWorkspaceRequest, CallSettings)
public override Operation<ConversionWorkspace, OperationMetadata> ConvertConversionWorkspace(ConvertConversionWorkspaceRequest request, CallSettings callSettings = null)Creates a draft tree schema for the destination database.
| Parameters | |
|---|---|
| Name | Description |
request | ConvertConversionWorkspaceRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationConversionWorkspaceOperationMetadata | The RPC response. |
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 | |
|---|---|
| Name | Description |
request | ConvertConversionWorkspaceRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationConversionWorkspaceOperationMetadata | A Task containing the RPC response. |
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 | CreateConnectionProfileRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationConnectionProfileOperationMetadata | 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 | CreateConnectionProfileRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationConnectionProfileOperationMetadata | A Task containing the RPC response. |
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 | |
|---|---|
| Name | Description |
request | CreateConversionWorkspaceRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationConversionWorkspaceOperationMetadata | The RPC response. |
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 | |
|---|---|
| Name | Description |
request | CreateConversionWorkspaceRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationConversionWorkspaceOperationMetadata | A Task containing the RPC response. |
CreateMappingRule(CreateMappingRuleRequest, CallSettings)
public override MappingRule CreateMappingRule(CreateMappingRuleRequest request, CallSettings callSettings = null)Creates a new mapping rule for a given conversion workspace.
| Parameters | |
|---|---|
| Name | Description |
request | CreateMappingRuleRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
MappingRule | The RPC response. |
CreateMappingRuleAsync(CreateMappingRuleRequest, CallSettings)
public override Task<MappingRule> CreateMappingRuleAsync(CreateMappingRuleRequest request, CallSettings callSettings = null)Creates a new mapping rule for a given conversion workspace.
| Parameters | |
|---|---|
| Name | Description |
request | CreateMappingRuleRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskMappingRule | 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 | CreateMigrationJobRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationMigrationJobOperationMetadata | 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 | CreateMigrationJobRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationMigrationJobOperationMetadata | A Task containing the RPC response. |
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 | |
|---|---|
| Name | Description |
request | CreatePrivateConnectionRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationPrivateConnectionOperationMetadata | The RPC response. |
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 | |
|---|---|
| Name | Description |
request | CreatePrivateConnectionRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationPrivateConnectionOperationMetadata | 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 | DeleteConnectionProfileRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationEmptyOperationMetadata | 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 | DeleteConnectionProfileRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationEmptyOperationMetadata | A Task containing the RPC response. |
DeleteConversionWorkspace(DeleteConversionWorkspaceRequest, CallSettings)
public override Operation<Empty, OperationMetadata> DeleteConversionWorkspace(DeleteConversionWorkspaceRequest request, CallSettings callSettings = null)Deletes a single conversion workspace.
| Parameters | |
|---|---|
| Name | Description |
request | DeleteConversionWorkspaceRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationEmptyOperationMetadata | The RPC response. |
DeleteConversionWorkspaceAsync(DeleteConversionWorkspaceRequest, CallSettings)
public override Task<Operation<Empty, OperationMetadata>> DeleteConversionWorkspaceAsync(DeleteConversionWorkspaceRequest request, CallSettings callSettings = null)Deletes a single conversion workspace.
| Parameters | |
|---|---|
| Name | Description |
request | DeleteConversionWorkspaceRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationEmptyOperationMetadata | A Task containing the RPC response. |
DeleteMappingRule(DeleteMappingRuleRequest, CallSettings)
public override void DeleteMappingRule(DeleteMappingRuleRequest request, CallSettings callSettings = null)Deletes a single mapping rule.
| Parameters | |
|---|---|
| Name | Description |
request | DeleteMappingRuleRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
DeleteMappingRuleAsync(DeleteMappingRuleRequest, CallSettings)
public override Task DeleteMappingRuleAsync(DeleteMappingRuleRequest request, CallSettings callSettings = null)Deletes a single mapping rule.
| Parameters | |
|---|---|
| Name | Description |
request | DeleteMappingRuleRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task | 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 | DeleteMigrationJobRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationEmptyOperationMetadata | 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 | DeleteMigrationJobRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationEmptyOperationMetadata | A Task containing the RPC response. |
DeletePrivateConnection(DeletePrivateConnectionRequest, CallSettings)
public override Operation<Empty, OperationMetadata> DeletePrivateConnection(DeletePrivateConnectionRequest request, CallSettings callSettings = null)Deletes a single Database Migration Service private connection.
| Parameters | |
|---|---|
| Name | Description |
request | DeletePrivateConnectionRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationEmptyOperationMetadata | The RPC response. |
DeletePrivateConnectionAsync(DeletePrivateConnectionRequest, CallSettings)
public override Task<Operation<Empty, OperationMetadata>> DeletePrivateConnectionAsync(DeletePrivateConnectionRequest request, CallSettings callSettings = null)Deletes a single Database Migration Service private connection.
| Parameters | |
|---|---|
| Name | Description |
request | DeletePrivateConnectionRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationEmptyOperationMetadata | A Task containing the RPC response. |
DescribeConversionWorkspaceRevisions(DescribeConversionWorkspaceRevisionsRequest, CallSettings)
public override DescribeConversionWorkspaceRevisionsResponse DescribeConversionWorkspaceRevisions(DescribeConversionWorkspaceRevisionsRequest request, CallSettings callSettings = null)Retrieves a list of committed revisions of a specific conversion workspace.
| Parameters | |
|---|---|
| Name | Description |
request | DescribeConversionWorkspaceRevisionsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
DescribeConversionWorkspaceRevisionsResponse | The RPC response. |
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 | |
|---|---|
| Name | Description |
request | DescribeConversionWorkspaceRevisionsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskDescribeConversionWorkspaceRevisionsResponse | A Task containing the RPC response. |
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 | |
|---|---|
| Name | Description |
request | DescribeDatabaseEntitiesRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedEnumerableDescribeDatabaseEntitiesResponseDatabaseEntity | A pageable sequence of DatabaseEntity resources. |
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 | |
|---|---|
| Name | Description |
request | DescribeDatabaseEntitiesRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedAsyncEnumerableDescribeDatabaseEntitiesResponseDatabaseEntity | A pageable asynchronous sequence of DatabaseEntity resources. |
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 | |
|---|---|
| Name | Description |
request | FetchStaticIpsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedEnumerableFetchStaticIpsResponsestring | A pageable sequence of string resources. |
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 | |
|---|---|
| Name | Description |
request | FetchStaticIpsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedAsyncEnumerableFetchStaticIpsResponsestring | A pageable asynchronous sequence of string resources. |
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 | GenerateSshScriptRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf 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 | GenerateSshScriptRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskSshScript | A Task containing the RPC response. |
GenerateTcpProxyScript(GenerateTcpProxyScriptRequest, CallSettings)
public override TcpProxyScript GenerateTcpProxyScript(GenerateTcpProxyScriptRequest request, CallSettings callSettings = null)Generate a TCP Proxy configuration script to configure a cloud-hosted VM running a TCP Proxy.
| Parameters | |
|---|---|
| Name | Description |
request | GenerateTcpProxyScriptRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TcpProxyScript | The RPC response. |
GenerateTcpProxyScriptAsync(GenerateTcpProxyScriptRequest, CallSettings)
public override Task<TcpProxyScript> GenerateTcpProxyScriptAsync(GenerateTcpProxyScriptRequest request, CallSettings callSettings = null)Generate a TCP Proxy configuration script to configure a cloud-hosted VM running a TCP Proxy.
| Parameters | |
|---|---|
| Name | Description |
request | GenerateTcpProxyScriptRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskTcpProxyScript | 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 | GetConnectionProfileRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf 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 | GetConnectionProfileRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskConnectionProfile | A Task containing the RPC response. |
GetConversionWorkspace(GetConversionWorkspaceRequest, CallSettings)
public override ConversionWorkspace GetConversionWorkspace(GetConversionWorkspaceRequest request, CallSettings callSettings = null)Gets details of a single conversion workspace.
| Parameters | |
|---|---|
| Name | Description |
request | GetConversionWorkspaceRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
ConversionWorkspace | The RPC response. |
GetConversionWorkspaceAsync(GetConversionWorkspaceRequest, CallSettings)
public override Task<ConversionWorkspace> GetConversionWorkspaceAsync(GetConversionWorkspaceRequest request, CallSettings callSettings = null)Gets details of a single conversion workspace.
| Parameters | |
|---|---|
| Name | Description |
request | GetConversionWorkspaceRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskConversionWorkspace | A Task containing the RPC response. |
GetMappingRule(GetMappingRuleRequest, CallSettings)
public override MappingRule GetMappingRule(GetMappingRuleRequest request, CallSettings callSettings = null)Gets the details of a mapping rule.
| Parameters | |
|---|---|
| Name | Description |
request | GetMappingRuleRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
MappingRule | The RPC response. |
GetMappingRuleAsync(GetMappingRuleRequest, CallSettings)
public override Task<MappingRule> GetMappingRuleAsync(GetMappingRuleRequest request, CallSettings callSettings = null)Gets the details of a mapping rule.
| Parameters | |
|---|---|
| Name | Description |
request | GetMappingRuleRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskMappingRule | 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 | GetMigrationJobRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf 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 | GetMigrationJobRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskMigrationJob | A Task containing the RPC response. |
GetPrivateConnection(GetPrivateConnectionRequest, CallSettings)
public override PrivateConnection GetPrivateConnection(GetPrivateConnectionRequest request, CallSettings callSettings = null)Gets details of a single private connection.
| Parameters | |
|---|---|
| Name | Description |
request | GetPrivateConnectionRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PrivateConnection | The RPC response. |
GetPrivateConnectionAsync(GetPrivateConnectionRequest, CallSettings)
public override Task<PrivateConnection> GetPrivateConnectionAsync(GetPrivateConnectionRequest request, CallSettings callSettings = null)Gets details of a single private connection.
| Parameters | |
|---|---|
| Name | Description |
request | GetPrivateConnectionRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskPrivateConnection | A Task containing the RPC response. |
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 | |
|---|---|
| Name | Description |
request | ImportMappingRulesRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationConversionWorkspaceOperationMetadata | The RPC response. |
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 | |
|---|---|
| Name | Description |
request | ImportMappingRulesRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationConversionWorkspaceOperationMetadata | A Task containing the RPC response. |
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 | |
|---|---|
| Name | Description |
request | ListConnectionProfilesRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedEnumerableListConnectionProfilesResponseConnectionProfile | A pageable sequence of ConnectionProfile resources. |
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 | |
|---|---|
| Name | Description |
request | ListConnectionProfilesRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedAsyncEnumerableListConnectionProfilesResponseConnectionProfile | A pageable asynchronous sequence of ConnectionProfile resources. |
ListConversionWorkspaces(ListConversionWorkspacesRequest, CallSettings)
public override PagedEnumerable<ListConversionWorkspacesResponse, ConversionWorkspace> ListConversionWorkspaces(ListConversionWorkspacesRequest request, CallSettings callSettings = null)Lists conversion workspaces in a given project and location.
| Parameters | |
|---|---|
| Name | Description |
request | ListConversionWorkspacesRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedEnumerableListConversionWorkspacesResponseConversionWorkspace | A pageable sequence of ConversionWorkspace resources. |
ListConversionWorkspacesAsync(ListConversionWorkspacesRequest, CallSettings)
public override PagedAsyncEnumerable<ListConversionWorkspacesResponse, ConversionWorkspace> ListConversionWorkspacesAsync(ListConversionWorkspacesRequest request, CallSettings callSettings = null)Lists conversion workspaces in a given project and location.
| Parameters | |
|---|---|
| Name | Description |
request | ListConversionWorkspacesRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedAsyncEnumerableListConversionWorkspacesResponseConversionWorkspace | A pageable asynchronous sequence of ConversionWorkspace resources. |
ListMappingRules(ListMappingRulesRequest, CallSettings)
public override PagedEnumerable<ListMappingRulesResponse, MappingRule> ListMappingRules(ListMappingRulesRequest request, CallSettings callSettings = null)Lists the mapping rules for a specific conversion workspace.
| Parameters | |
|---|---|
| Name | Description |
request | ListMappingRulesRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedEnumerableListMappingRulesResponseMappingRule | A pageable sequence of MappingRule resources. |
ListMappingRulesAsync(ListMappingRulesRequest, CallSettings)
public override PagedAsyncEnumerable<ListMappingRulesResponse, MappingRule> ListMappingRulesAsync(ListMappingRulesRequest request, CallSettings callSettings = null)Lists the mapping rules for a specific conversion workspace.
| Parameters | |
|---|---|
| Name | Description |
request | ListMappingRulesRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedAsyncEnumerableListMappingRulesResponseMappingRule | A pageable asynchronous sequence of MappingRule 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 | ListMigrationJobsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedEnumerableListMigrationJobsResponseMigrationJob | 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 | ListMigrationJobsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedAsyncEnumerableListMigrationJobsResponseMigrationJob | A pageable asynchronous sequence of MigrationJob resources. |
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 | |
|---|---|
| Name | Description |
request | ListPrivateConnectionsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedEnumerableListPrivateConnectionsResponsePrivateConnection | A pageable sequence of PrivateConnection resources. |
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 | |
|---|---|
| Name | Description |
request | ListPrivateConnectionsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedAsyncEnumerableListPrivateConnectionsResponsePrivateConnection | A pageable asynchronous sequence of PrivateConnection 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 | PromoteMigrationJobRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationMigrationJobOperationMetadata | 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 | PromoteMigrationJobRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationMigrationJobOperationMetadata | 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 | RestartMigrationJobRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationMigrationJobOperationMetadata | 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 | RestartMigrationJobRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationMigrationJobOperationMetadata | 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 | ResumeMigrationJobRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationMigrationJobOperationMetadata | 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 | ResumeMigrationJobRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationMigrationJobOperationMetadata | A Task containing the RPC response. |
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 | |
|---|---|
| Name | Description |
request | RollbackConversionWorkspaceRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationConversionWorkspaceOperationMetadata | The RPC response. |
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 | |
|---|---|
| Name | Description |
request | RollbackConversionWorkspaceRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationConversionWorkspaceOperationMetadata | A Task containing the RPC response. |
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 | |
|---|---|
| Name | Description |
request | SearchBackgroundJobsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
SearchBackgroundJobsResponse | The RPC response. |
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 | |
|---|---|
| Name | Description |
request | SearchBackgroundJobsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskSearchBackgroundJobsResponse | A Task containing the RPC response. |
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 | |
|---|---|
| Name | Description |
request | SeedConversionWorkspaceRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationConversionWorkspaceOperationMetadata | The RPC response. |
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 | |
|---|---|
| Name | Description |
request | SeedConversionWorkspaceRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationConversionWorkspaceOperationMetadata | 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 | StartMigrationJobRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationMigrationJobOperationMetadata | 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 | StartMigrationJobRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationMigrationJobOperationMetadata | 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 | StopMigrationJobRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationMigrationJobOperationMetadata | 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 | StopMigrationJobRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationMigrationJobOperationMetadata | 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 | UpdateConnectionProfileRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationConnectionProfileOperationMetadata | 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 | UpdateConnectionProfileRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationConnectionProfileOperationMetadata | A Task containing the RPC response. |
UpdateConversionWorkspace(UpdateConversionWorkspaceRequest, CallSettings)
public override Operation<ConversionWorkspace, OperationMetadata> UpdateConversionWorkspace(UpdateConversionWorkspaceRequest request, CallSettings callSettings = null)Updates the parameters of a single conversion workspace.
| Parameters | |
|---|---|
| Name | Description |
request | UpdateConversionWorkspaceRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationConversionWorkspaceOperationMetadata | The RPC response. |
UpdateConversionWorkspaceAsync(UpdateConversionWorkspaceRequest, CallSettings)
public override Task<Operation<ConversionWorkspace, OperationMetadata>> UpdateConversionWorkspaceAsync(UpdateConversionWorkspaceRequest request, CallSettings callSettings = null)Updates the parameters of a single conversion workspace.
| Parameters | |
|---|---|
| Name | Description |
request | UpdateConversionWorkspaceRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationConversionWorkspaceOperationMetadata | 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 | UpdateMigrationJobRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationMigrationJobOperationMetadata | 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 | UpdateMigrationJobRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationMigrationJobOperationMetadata | 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 | VerifyMigrationJobRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationMigrationJobOperationMetadata | 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 | VerifyMigrationJobRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationMigrationJobOperationMetadata | A Task containing the RPC response. |