Show / Hide Table of Contents

Class MigrationClient

Service client instance for Migration.

Inheritance
object
ClientBase
RegionalClientBase
MigrationClient
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.CloudmigrationsService
Assembly: OCI.DotNetSDK.Cloudmigrations.dll
Syntax
public class MigrationClient : RegionalClientBase, IDisposable

Constructors

MigrationClient(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 MigrationClient(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 MigrationPaginators Paginators { get; }
Property Value
Type Description
MigrationPaginators

Waiters

Declaration
public MigrationWaiters Waiters { get; }
Property Value
Type Description
MigrationWaiters

Methods

CancelWorkRequest(CancelWorkRequestRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Cancels work request with the given ID.

Declaration
public Task<CancelWorkRequestResponse> CancelWorkRequest(CancelWorkRequestRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
CancelWorkRequestRequest 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<CancelWorkRequestResponse>

A response object containing details about the completed operation

Examples

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

ChangeMigrationCompartment(ChangeMigrationCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Moves a migration resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource.

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.

ChangeMigrationPlanCompartment(ChangeMigrationPlanCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Moves a resource into a different compartment. When provided, If-Match is checked against ETag values of the resource.

Declaration
public Task<ChangeMigrationPlanCompartmentResponse> ChangeMigrationPlanCompartment(ChangeMigrationPlanCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ChangeMigrationPlanCompartmentRequest 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<ChangeMigrationPlanCompartmentResponse>

A response object containing details about the completed operation

Examples

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

ChangeReplicationScheduleCompartment(ChangeReplicationScheduleCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Moves a resource into a different compartment. When provided, If-Match is checked against ETag values of the resource.

Declaration
public Task<ChangeReplicationScheduleCompartmentResponse> ChangeReplicationScheduleCompartment(ChangeReplicationScheduleCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ChangeReplicationScheduleCompartmentRequest 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<ChangeReplicationScheduleCompartmentResponse>

A response object containing details about the completed operation

Examples

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

CreateMigration(CreateMigrationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a migration.

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.

CreateMigrationAsset(CreateMigrationAssetRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a migration asset.

Declaration
public Task<CreateMigrationAssetResponse> CreateMigrationAsset(CreateMigrationAssetRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
CreateMigrationAssetRequest 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<CreateMigrationAssetResponse>

A response object containing details about the completed operation

Examples

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

CreateMigrationPlan(CreateMigrationPlanRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a migration plan.

Declaration
public Task<CreateMigrationPlanResponse> CreateMigrationPlan(CreateMigrationPlanRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
CreateMigrationPlanRequest 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<CreateMigrationPlanResponse>

A response object containing details about the completed operation

Examples

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

CreateReplicationSchedule(CreateReplicationScheduleRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a replication schedule.

Declaration
public Task<CreateReplicationScheduleResponse> CreateReplicationSchedule(CreateReplicationScheduleRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
CreateReplicationScheduleRequest 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<CreateReplicationScheduleResponse>

A response object containing details about the completed operation

Examples

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

CreateTargetAsset(CreateTargetAssetRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a target asset.

Declaration
public Task<CreateTargetAssetResponse> CreateTargetAsset(CreateTargetAssetRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
CreateTargetAssetRequest 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<CreateTargetAssetResponse>

A response object containing details about the completed operation

Examples

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

DeleteMigration(DeleteMigrationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes a migration resource by identifier.

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.

DeleteMigrationAsset(DeleteMigrationAssetRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes a migration asset resource by an identifier.

Declaration
public Task<DeleteMigrationAssetResponse> DeleteMigrationAsset(DeleteMigrationAssetRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
DeleteMigrationAssetRequest 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<DeleteMigrationAssetResponse>

A response object containing details about the completed operation

Examples

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

DeleteMigrationPlan(DeleteMigrationPlanRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes a migration plan resource by an identifier.

Declaration
public Task<DeleteMigrationPlanResponse> DeleteMigrationPlan(DeleteMigrationPlanRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
DeleteMigrationPlanRequest 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<DeleteMigrationPlanResponse>

A response object containing details about the completed operation

Examples

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

DeleteReplicationSchedule(DeleteReplicationScheduleRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes a replication schedule resource by identifier.

Declaration
public Task<DeleteReplicationScheduleResponse> DeleteReplicationSchedule(DeleteReplicationScheduleRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
DeleteReplicationScheduleRequest 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<DeleteReplicationScheduleResponse>

A response object containing details about the completed operation

Examples

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

DeleteTargetAsset(DeleteTargetAssetRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes a target asset resource by identifier.

Declaration
public Task<DeleteTargetAssetResponse> DeleteTargetAsset(DeleteTargetAssetRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
DeleteTargetAssetRequest 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<DeleteTargetAssetResponse>

A response object containing details about the completed operation

Examples

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

ExecuteMigrationPlan(ExecuteMigrationPlanRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Executes the migration plan with the migration plan ID.

Declaration
public Task<ExecuteMigrationPlanResponse> ExecuteMigrationPlan(ExecuteMigrationPlanRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ExecuteMigrationPlanRequest 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<ExecuteMigrationPlanResponse>

A response object containing details about the completed operation

Examples

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

ExportMigrationPlan(ExportMigrationPlanRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Exports the migration plan to a csv file.

Declaration
public Task<ExportMigrationPlanResponse> ExportMigrationPlan(ExportMigrationPlanRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ExportMigrationPlanRequest 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<ExportMigrationPlanResponse>

A response object containing details about the completed operation

Examples

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

GetMigration(GetMigrationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets a migration by identifier.

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.

GetMigrationAsset(GetMigrationAssetRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets a migration asset by identifier.

Declaration
public Task<GetMigrationAssetResponse> GetMigrationAsset(GetMigrationAssetRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
GetMigrationAssetRequest 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<GetMigrationAssetResponse>

A response object containing details about the completed operation

Examples

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

GetMigrationPlan(GetMigrationPlanRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets a migration plan by identifier.

Declaration
public Task<GetMigrationPlanResponse> GetMigrationPlan(GetMigrationPlanRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
GetMigrationPlanRequest 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<GetMigrationPlanResponse>

A response object containing details about the completed operation

Examples

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

GetReplicationProgress(GetReplicationProgressRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets the progress percentage of a migration asset's replication process.

Declaration
public Task<GetReplicationProgressResponse> GetReplicationProgress(GetReplicationProgressRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
GetReplicationProgressRequest 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<GetReplicationProgressResponse>

A response object containing details about the completed operation

Examples

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

GetReplicationSchedule(GetReplicationScheduleRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets a replication schedule by identifier.

Declaration
public Task<GetReplicationScheduleResponse> GetReplicationSchedule(GetReplicationScheduleRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
GetReplicationScheduleRequest 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<GetReplicationScheduleResponse>

A response object containing details about the completed operation

Examples

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

GetTargetAsset(GetTargetAssetRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets a target asset by identifier.

Declaration
public Task<GetTargetAssetResponse> GetTargetAsset(GetTargetAssetRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
GetTargetAssetRequest 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<GetTargetAssetResponse>

A response object containing details about the completed operation

Examples

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

GetWorkRequest(GetWorkRequestRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets the status of the work request with the given ID.

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.

ImportMigrationPlan(ImportMigrationPlanRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Imports a migration plan from a csv file.

Declaration
public Task<ImportMigrationPlanResponse> ImportMigrationPlan(ImportMigrationPlanRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ImportMigrationPlanRequest 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<ImportMigrationPlanResponse>

A response object containing details about the completed operation

Examples

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

ListAvailableShapes(ListAvailableShapesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

List of shapes by parameters.

Declaration
public Task<ListAvailableShapesResponse> ListAvailableShapes(ListAvailableShapesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ListAvailableShapesRequest 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<ListAvailableShapesResponse>

A response object containing details about the completed operation

Examples

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

ListMigrationAssets(ListMigrationAssetsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Returns a list of migration assets.

Declaration
public Task<ListMigrationAssetsResponse> ListMigrationAssets(ListMigrationAssetsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ListMigrationAssetsRequest 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<ListMigrationAssetsResponse>

A response object containing details about the completed operation

Examples

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

ListMigrationPlans(ListMigrationPlansRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Returns a list of migration plans.

Declaration
public Task<ListMigrationPlansResponse> ListMigrationPlans(ListMigrationPlansRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ListMigrationPlansRequest 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<ListMigrationPlansResponse>

A response object containing details about the completed operation

Examples

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

ListMigrations(ListMigrationsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Returns a list of 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.

ListReplicationSchedules(ListReplicationSchedulesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Returns a list of replication schedules.

Declaration
public Task<ListReplicationSchedulesResponse> ListReplicationSchedules(ListReplicationSchedulesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ListReplicationSchedulesRequest 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<ListReplicationSchedulesResponse>

A response object containing details about the completed operation

Examples

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

ListTargetAssets(ListTargetAssetsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Returns a list of target assets.

Declaration
public Task<ListTargetAssetsResponse> ListTargetAssets(ListTargetAssetsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ListTargetAssetsRequest 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<ListTargetAssetsResponse>

A response object containing details about the completed operation

Examples

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

ListWorkRequestErrors(ListWorkRequestErrorsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Returns a paginated list of errors for a given 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)

Returns a paginated list of logs for a given 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)

List of work requests in a compartment.

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.

RefreshMigration(RefreshMigrationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Refreshes migration based on the migration ID.

Declaration
public Task<RefreshMigrationResponse> RefreshMigration(RefreshMigrationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
RefreshMigrationRequest 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<RefreshMigrationResponse>

A response object containing details about the completed operation

Examples

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

RefreshMigrationAsset(RefreshMigrationAssetRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Refreshes the migration asset with the migration asset ID.

Declaration
public Task<RefreshMigrationAssetResponse> RefreshMigrationAsset(RefreshMigrationAssetRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
RefreshMigrationAssetRequest 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<RefreshMigrationAssetResponse>

A response object containing details about the completed operation

Examples

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

RefreshMigrationPlan(RefreshMigrationPlanRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Refreshes the migration plan with the migration plan ID.

Declaration
public Task<RefreshMigrationPlanResponse> RefreshMigrationPlan(RefreshMigrationPlanRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
RefreshMigrationPlanRequest 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<RefreshMigrationPlanResponse>

A response object containing details about the completed operation

Examples

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

StartAssetReplication(StartAssetReplicationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Starts replication for the asset with the migration asset ID.

Declaration
public Task<StartAssetReplicationResponse> StartAssetReplication(StartAssetReplicationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
StartAssetReplicationRequest 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<StartAssetReplicationResponse>

A response object containing details about the completed operation

Examples

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

StartMigrationReplication(StartMigrationReplicationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Starts replication for a migration or for some asset.

Declaration
public Task<StartMigrationReplicationResponse> StartMigrationReplication(StartMigrationReplicationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
StartMigrationReplicationRequest 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<StartMigrationReplicationResponse>

A response object containing details about the completed operation

Examples

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

UpdateMigration(UpdateMigrationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates the migration.

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.

UpdateMigrationAsset(UpdateMigrationAssetRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates the migration asset.

Declaration
public Task<UpdateMigrationAssetResponse> UpdateMigrationAsset(UpdateMigrationAssetRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
UpdateMigrationAssetRequest 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<UpdateMigrationAssetResponse>

A response object containing details about the completed operation

Examples

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

UpdateMigrationPlan(UpdateMigrationPlanRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates the migration plan.

Declaration
public Task<UpdateMigrationPlanResponse> UpdateMigrationPlan(UpdateMigrationPlanRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
UpdateMigrationPlanRequest 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<UpdateMigrationPlanResponse>

A response object containing details about the completed operation

Examples

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

UpdateReplicationSchedule(UpdateReplicationScheduleRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates the replication schedule.

Declaration
public Task<UpdateReplicationScheduleResponse> UpdateReplicationSchedule(UpdateReplicationScheduleRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
UpdateReplicationScheduleRequest 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<UpdateReplicationScheduleResponse>

A response object containing details about the completed operation

Examples

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

UpdateTargetAsset(UpdateTargetAssetRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates the target asset.

Declaration
public Task<UpdateTargetAssetResponse> UpdateTargetAsset(UpdateTargetAssetRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
UpdateTargetAssetRequest 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<UpdateTargetAssetResponse>

A response object containing details about the completed operation

Examples

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

Implements

IDisposable
In this article
Back to top