Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MigrationClient

This service client uses {@link common.CircuitBreaker.DefaultConfiguration} for all the operations by default if no circuit breaker configuration is defined by the user.

Hierarchy

  • MigrationClient

Constructors

constructor

  • new MigrationClient(params: common.AuthParams, clientConfiguration?: common.ClientConfiguration): MigrationClient

Properties

Protected _bodyDuplexMode

_bodyDuplexMode: any = undefined

Protected _circuitBreaker

_circuitBreaker: typeof Breaker | null = null

Protected _clientConfiguration

_clientConfiguration: ClientConfiguration

Protected _defaultHeaders

_defaultHeaders: any

Protected _endpoint

_endpoint: string = ""

Protected _httpClient

_httpClient: HttpClient

Protected _httpOptions

_httpOptions: any = undefined

Protected _lastSetRegionOrRegionId

_lastSetRegionOrRegionId: string = ""

Protected _realmSpecificEndpointTemplateEnabled

_realmSpecificEndpointTemplateEnabled: boolean | undefined = undefined

Protected _region

_region: Region

Protected _regionId

_regionId: string = ""

Protected _waiters

_waiters: MigrationWaiter

targetService

targetService: string = "Migration"

Static Protected endpointServiceName

endpointServiceName: string = ""

Static Protected serviceEndpointTemplate

serviceEndpointTemplate: string = "https://cloudmigration.{region}.oci.{secondLevelDomain}"

Accessors

endpoint

  • get endpoint(): string
  • set endpoint(endpoint: string): void

logger

region

  • set region(region: Region): void
  • Sets the region to call (ex, Region.US_PHOENIX_1). Note, this will call {@link #endpoint(String) endpoint} after resolving the endpoint.

    Parameters

    • region: Region

      The region of the service.

    Returns void

regionId

  • set regionId(regionId: string): void
  • Sets the regionId to call (ex, 'us-phoenix-1').

    Note, this will first try to map the region ID to a known Region and call {@link #region(Region) region}. If no known Region could be determined, it will create an endpoint assuming its in default Realm OC1 and then call {@link #endpoint(String) endpoint}.

    Parameters

    • regionId: string

      The public region ID.

    Returns void

useRealmSpecificEndpointTemplate

  • set useRealmSpecificEndpointTemplate(realmSpecificEndpointTemplateEnabled: boolean): void
  • Determines whether realm specific endpoint should be used or not. Set realmSpecificEndpointTemplateEnabled to "true" if the user wants to enable use of realm specific endpoint template, otherwise set it to "false"

    Parameters

    • realmSpecificEndpointTemplateEnabled: boolean

      flag to enable the use of realm specific endpoint template

    Returns void

Methods

cancelWorkRequest

changeMigrationCompartment

  • Moves a migration resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ChangeMigrationCompartment API.

    Parameters

    Returns Promise<ChangeMigrationCompartmentResponse>

    ChangeMigrationCompartmentResponse

changeMigrationPlanCompartment

  • Moves a resource into a different compartment. When provided, If-Match is checked against ETag values of the resource. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ChangeMigrationPlanCompartment API.

    Parameters

    Returns Promise<ChangeMigrationPlanCompartmentResponse>

    ChangeMigrationPlanCompartmentResponse

changeReplicationScheduleCompartment

close

  • close(): void

createMigration

createMigrationAsset

createMigrationPlan

createReplicationSchedule

createTargetAsset

createWaiters

  • Creates a new MigrationWaiter for resources for this service.

    Parameters

    • Optional config: common.WaiterConfiguration

      The waiter configuration for termination and delay strategy

    Returns MigrationWaiter

    The service waiters.

deleteMigration

  • Deletes a migration resource by identifier. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DeleteMigration API.

    Parameters

    Returns Promise<DeleteMigrationResponse>

    DeleteMigrationResponse

deleteMigrationAsset

deleteMigrationPlan

deleteReplicationSchedule

deleteTargetAsset

executeMigrationPlan

exportMigrationPlan

getMigration

getMigrationAsset

getMigrationPlan

getReplicationProgress

getReplicationSchedule

getTargetAsset

getWaiters

getWorkRequest

  • Gets the status of the work request with the given ID. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetWorkRequest API.

    Parameters

    Returns Promise<GetWorkRequestResponse>

    GetWorkRequestResponse

importMigrationPlan

listAvailableShapes

listMigrationAssets

listMigrationPlans

listMigrations

listReplicationSchedules

listTargetAssets

listWorkRequestErrors

listWorkRequestLogs

listWorkRequests

refreshMigration

refreshMigrationAsset

refreshMigrationPlan

shutdownCircuitBreaker

  • shutdownCircuitBreaker(): void

startAssetReplication

startMigrationReplication

updateMigration

updateMigrationAsset

updateMigrationPlan

updateReplicationSchedule

updateTargetAsset