Class DatabaseMigrationClient

Service client instance for DatabaseMigration.

Inheritance

object

ClientBase

RegionalClientBase

DatabaseMigrationClient

Implements

IDisposable

Inherited Members

RegionalClientBase.logger

RegionalClientBase.SetRegion(Region)

RegionalClientBase.SetRegion(string)

RegionalClientBase.UseRealmSpecificEndpointTemplate(bool)

RegionalClientBase.PopulateServiceParametersInEndpointTemplate(RestClient, Dictionary<string, object>)

RegionalClientBase.parseEndpointForParameters(string)

ClientBase.restClient

ClientBase.service

ClientBase.userAgent

ClientBase.Dispose()

ClientBase.Dispose(bool)

ClientBase.SetEndpoint(string)

ClientBase.GetEndpoint()

ClientBase.GetUserAgent()

ClientBase.SetRealmSpecificEndpointTemplate(string)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.DatabasemigrationService

Assembly: OCI.DotNetSDK.Databasemigration.dll

Syntax

public class DatabaseMigrationClient : RegionalClientBase, IDisposable

Constructors

DatabaseMigrationClient(IBasicAuthenticationDetailsProvider, ClientConfiguration, string)

Creates a new service instance using the given authentication provider and/or client configuration and/or endpoint. A client configuration can also be provided optionally to adjust REST client behaviors.

Declaration

public DatabaseMigrationClient(IBasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration clientConfiguration = null, string endpoint = null)

Parameters

Type	Name	Description
IBasicAuthenticationDetailsProvider	authenticationDetailsProvider	The authentication details provider. Required.
ClientConfiguration	clientConfiguration	The client configuration that contains settings to adjust REST client behaviors. Optional.
string	endpoint	The endpoint of the service. If not provided and the client is a regional client, the endpoint will be constructed based on region information. Optional.

Properties

Paginators

Declaration

public DatabaseMigrationPaginators Paginators { get; }

Property Value

Type	Description
DatabaseMigrationPaginators

Waiters

Declaration

public DatabaseMigrationWaiters Waiters { get; }

Property Value

Type	Description
DatabaseMigrationWaiters

Methods

AbortJob(AbortJobRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Aborts a Migration Job (either Evaluation or Migration).

Declaration

public Task<AbortJobResponse> AbortJob(AbortJobRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
AbortJobRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<AbortJobResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use AbortJob API.

AddMigrationObjects(AddMigrationObjectsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Add excluded/included object to the list.

Declaration

public Task<AddMigrationObjectsResponse> AddMigrationObjects(AddMigrationObjectsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
AddMigrationObjectsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<AddMigrationObjectsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use AddMigrationObjects API.

ChangeConnectionCompartment(ChangeConnectionCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Used to change the Database Connection compartment.

Declaration

public Task<ChangeConnectionCompartmentResponse> ChangeConnectionCompartment(ChangeConnectionCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ChangeConnectionCompartmentRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ChangeConnectionCompartmentResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ChangeConnectionCompartment API.

ChangeMigrationCompartment(ChangeMigrationCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Used to change the Migration compartment.

Declaration

public Task<ChangeMigrationCompartmentResponse> ChangeMigrationCompartment(ChangeMigrationCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ChangeMigrationCompartmentRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ChangeMigrationCompartmentResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ChangeMigrationCompartment API.

CloneMigration(CloneMigrationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Clone a configuration from an existing Migration.

Declaration

public Task<CloneMigrationResponse> CloneMigration(CloneMigrationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CloneMigrationRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<CloneMigrationResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CloneMigration API.

ConnectionDiagnostics(ConnectionDiagnosticsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Perform connection test for a database connection.

Declaration

public Task<ConnectionDiagnosticsResponse> ConnectionDiagnostics(ConnectionDiagnosticsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ConnectionDiagnosticsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ConnectionDiagnosticsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ConnectionDiagnostics API.

CreateConnection(CreateConnectionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Create a Database Connection resource that contains the details to connect to either a Source or Target Database in the migration.

Declaration

public Task<CreateConnectionResponse> CreateConnection(CreateConnectionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateConnectionRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<CreateConnectionResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateConnection API.

CreateMigration(CreateMigrationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Create a Migration resource that contains all the details to perform the database migration operation, such as source and destination database details, credentials, etc.

Declaration

public Task<CreateMigrationResponse> CreateMigration(CreateMigrationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateMigrationRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<CreateMigrationResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateMigration API.

CreateParameterFileVersion(CreateParameterFileVersionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a new version of the current parameter file contents to the specified value.

Declaration

public Task<CreateParameterFileVersionResponse> CreateParameterFileVersion(CreateParameterFileVersionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateParameterFileVersionRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<CreateParameterFileVersionResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateParameterFileVersion API.

DeleteConnection(DeleteConnectionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes the Database Connection represented by the specified connection ID.

Declaration

public Task<DeleteConnectionResponse> DeleteConnection(DeleteConnectionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteConnectionRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<DeleteConnectionResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeleteConnection API.

DeleteJob(DeleteJobRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes the migration job represented by the given job ID.

Declaration

public Task<DeleteJobResponse> DeleteJob(DeleteJobRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteJobRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<DeleteJobResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeleteJob API.

DeleteMigration(DeleteMigrationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes the Migration represented by the specified migration ID.

Declaration

public Task<DeleteMigrationResponse> DeleteMigration(DeleteMigrationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteMigrationRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<DeleteMigrationResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeleteMigration API.

DeleteParameterFileVersion(DeleteParameterFileVersionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes the given parameter file version

Declaration

public Task<DeleteParameterFileVersionResponse> DeleteParameterFileVersion(DeleteParameterFileVersionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteParameterFileVersionRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<DeleteParameterFileVersionResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeleteParameterFileVersion API.

EvaluateMigration(EvaluateMigrationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Start Validate Migration job.

Declaration

public Task<EvaluateMigrationResponse> EvaluateMigration(EvaluateMigrationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
EvaluateMigrationRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<EvaluateMigrationResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use EvaluateMigration API.

GetAdvisorReport(GetAdvisorReportRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Get the Pre-Migration Advisor report details

Declaration

public Task<GetAdvisorReportResponse> GetAdvisorReport(GetAdvisorReportRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetAdvisorReportRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetAdvisorReportResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetAdvisorReport API.

GetConnection(GetConnectionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Display Database Connection details.

Declaration

public Task<GetConnectionResponse> GetConnection(GetConnectionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetConnectionRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetConnectionResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetConnection API.

GetJob(GetJobRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Get a migration job.

Declaration

public Task<GetJobResponse> GetJob(GetJobRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetJobRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetJobResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetJob API.

GetJobOutputContent(GetJobOutputContentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Get the migration Job Output content as a String.

Declaration

public Task<GetJobOutputContentResponse> GetJobOutputContent(GetJobOutputContentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetJobOutputContentRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetJobOutputContentResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetJobOutputContent API.

GetMigration(GetMigrationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Display Migration details.

Declaration

public Task<GetMigrationResponse> GetMigration(GetMigrationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetMigrationRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetMigrationResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetMigration API.

GetParameterFileVersion(GetParameterFileVersionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Obtain the parameter file version contents for the specified parameter file name and the associated job. This operation will be allowed only if the job is certain acceptable lifecycle states.

Declaration

public Task<GetParameterFileVersionResponse> GetParameterFileVersion(GetParameterFileVersionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetParameterFileVersionRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetParameterFileVersionResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetParameterFileVersion API.

GetWorkRequest(GetWorkRequestRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets the details of a work request.

Declaration

public Task<GetWorkRequestResponse> GetWorkRequest(GetWorkRequestRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetWorkRequestRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetWorkRequestResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetWorkRequest API.

ListConnections(ListConnectionsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

List all Database Connections.

Declaration

public Task<ListConnectionsResponse> ListConnections(ListConnectionsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListConnectionsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListConnectionsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListConnections API.

ListExcludedObjects(ListExcludedObjectsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

List the excluded database objects.

Declaration

public Task<ListExcludedObjectsResponse> ListExcludedObjects(ListExcludedObjectsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListExcludedObjectsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListExcludedObjectsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListExcludedObjects API.

ListJobOutputs(ListJobOutputsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

List the Job Outputs

Declaration

public Task<ListJobOutputsResponse> ListJobOutputs(ListJobOutputsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListJobOutputsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListJobOutputsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListJobOutputs API.

ListJobs(ListJobsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

List all the names of the Migration jobs associated to the specified migration site.

Declaration

public Task<ListJobsResponse> ListJobs(ListJobsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListJobsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListJobsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListJobs API.

ListMigrationObjectTypes(ListMigrationObjectTypesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Display sample object types to exclude or include for a Migration.

Declaration

public Task<ListMigrationObjectTypesResponse> ListMigrationObjectTypes(ListMigrationObjectTypesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListMigrationObjectTypesRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListMigrationObjectTypesResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListMigrationObjectTypes API.

ListMigrationObjects(ListMigrationObjectsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Display excluded/included objects.

Declaration

public Task<ListMigrationObjectsResponse> ListMigrationObjects(ListMigrationObjectsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListMigrationObjectsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListMigrationObjectsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListMigrationObjects API.

ListMigrationParameters(ListMigrationParametersRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

List of parameters that can be used to customize migrations.

Declaration

public Task<ListMigrationParametersResponse> ListMigrationParameters(ListMigrationParametersRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListMigrationParametersRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListMigrationParametersResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListMigrationParameters API.

ListMigrations(ListMigrationsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

List all Migrations.

Declaration

public Task<ListMigrationsResponse> ListMigrations(ListMigrationsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListMigrationsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListMigrationsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListMigrations API.

ListParameterFileVersions(ListParameterFileVersionsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Return a list of the parameter file metadata of the migration execution of the specified job. This will only be acceptable if the job is in particular state. It will be accessible if the job is in the FAILED, PAUSED or SUSPENDED state.

Declaration

public Task<ListParameterFileVersionsResponse> ListParameterFileVersions(ListParameterFileVersionsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListParameterFileVersionsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListParameterFileVersionsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListParameterFileVersions API.

ListWorkRequestErrors(ListWorkRequestErrorsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets the errors for a work request.

Declaration

public Task<ListWorkRequestErrorsResponse> ListWorkRequestErrors(ListWorkRequestErrorsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListWorkRequestErrorsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListWorkRequestErrorsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListWorkRequestErrors API.

ListWorkRequestLogs(ListWorkRequestLogsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets the logs for a work request.

Declaration

public Task<ListWorkRequestLogsResponse> ListWorkRequestLogs(ListWorkRequestLogsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListWorkRequestLogsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListWorkRequestLogsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListWorkRequestLogs API.

ListWorkRequests(ListWorkRequestsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists the work requests in a compartment or for a specified resource.

Declaration

public Task<ListWorkRequestsResponse> ListWorkRequests(ListWorkRequestsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListWorkRequestsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListWorkRequestsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListWorkRequests API.

MakeCurrentParameterFileVersion(MakeCurrentParameterFileVersionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Make current the given parameter file version

Declaration

public Task<MakeCurrentParameterFileVersionResponse> MakeCurrentParameterFileVersion(MakeCurrentParameterFileVersionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
MakeCurrentParameterFileVersionRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<MakeCurrentParameterFileVersionResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use MakeCurrentParameterFileVersion API.

RemoveMigrationObjects(RemoveMigrationObjectsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Remove excluded/included objects.

Declaration

public Task<RemoveMigrationObjectsResponse> RemoveMigrationObjects(RemoveMigrationObjectsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
RemoveMigrationObjectsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<RemoveMigrationObjectsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use RemoveMigrationObjects API.

ResumeJob(ResumeJobRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Resume a migration Job.

Declaration

public Task<ResumeJobResponse> ResumeJob(ResumeJobRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ResumeJobRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ResumeJobResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ResumeJob API.

RetrieveSupportedPhases(RetrieveSupportedPhasesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Display Migration Phases for a specified migration.

Declaration

public Task<RetrieveSupportedPhasesResponse> RetrieveSupportedPhases(RetrieveSupportedPhasesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
RetrieveSupportedPhasesRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<RetrieveSupportedPhasesResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use RetrieveSupportedPhases API.

StartMigration(StartMigrationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Start Migration job.

Declaration

public Task<StartMigrationResponse> StartMigration(StartMigrationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
StartMigrationRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<StartMigrationResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use StartMigration API.

SuspendJob(SuspendJobRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Place the currently executing migration Job in a Suspended State.

Declaration

public Task<SuspendJobResponse> SuspendJob(SuspendJobRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
SuspendJobRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<SuspendJobResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use SuspendJob API.

UpdateConnection(UpdateConnectionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Update Database Connection resource details.

Declaration

public Task<UpdateConnectionResponse> UpdateConnection(UpdateConnectionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
UpdateConnectionRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<UpdateConnectionResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use UpdateConnection API.

UpdateJob(UpdateJobRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Update Migration Job resource details.

Declaration

public Task<UpdateJobResponse> UpdateJob(UpdateJobRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
UpdateJobRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<UpdateJobResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use UpdateJob API.

UpdateMigration(UpdateMigrationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Update Migration resource details.

Declaration

public Task<UpdateMigrationResponse> UpdateMigration(UpdateMigrationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
UpdateMigrationRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<UpdateMigrationResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use UpdateMigration API.

Implements

IDisposable