Options
All
  • Public
  • Public/Protected
  • All
Menu

Class DatabaseMigrationClient

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

  • DatabaseMigrationClient

Constructors

constructor

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

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

targetService

targetService: string = "DatabaseMigration"

Static Protected endpointServiceName

endpointServiceName: string = ""

Static Protected serviceEndpointTemplate

serviceEndpointTemplate: string = "https://odms.{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

abortJob

  • Aborts a Migration Job (either Evaluation or Migration).

    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 AbortJob API.

    Parameters

    Returns Promise<AbortJobResponse>

    AbortJobResponse

addMigrationObjects

changeAgentCompartment

changeConnectionCompartment

changeMigrationCompartment

cloneMigration

  • Clone a configuration from an existing Migration.

    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 CloneMigration API.

    Parameters

    Returns Promise<CloneMigrationResponse>

    CloneMigrationResponse

close

  • close(): void

connectionDiagnostics

createConnection

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

    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 CreateConnection API.

    Parameters

    Returns Promise<CreateConnectionResponse>

    CreateConnectionResponse

createMigration

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

    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 CreateMigration API.

    Parameters

    Returns Promise<CreateMigrationResponse>

    CreateMigrationResponse

createWaiters

deleteAgent

  • Delete the ODMS Agent represented by the specified ODMS Agent 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 DeleteAgent API.

    Parameters

    Returns Promise<DeleteAgentResponse>

    DeleteAgentResponse

deleteConnection

  • Deletes the Database Connection represented by the specified connection 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 DeleteConnection API.

    Parameters

    Returns Promise<DeleteConnectionResponse>

    DeleteConnectionResponse

deleteJob

  • Deletes the migration job represented by the given job 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 DeleteJob API.

    Parameters

    Returns Promise<DeleteJobResponse>

    DeleteJobResponse

deleteMigration

  • Deletes the Migration represented by the specified migration 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 DeleteMigration API.

    Parameters

    Returns Promise<DeleteMigrationResponse>

    DeleteMigrationResponse

evaluateMigration

getAdvisorReport

getAgent

  • Display the ODMS Agent configuration.

    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 GetAgent API.

    Parameters

    Returns Promise<GetAgentResponse>

    GetAgentResponse

getConnection

getJob

  • Get a migration job.

    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 GetJob API.

    Parameters

    Returns Promise<GetJobResponse>

    GetJobResponse

getJobOutputContent

getMigration

getWaiters

getWorkRequest

listAgentImages

  • Get details of the ODMS Agent Images available to install on-premises.

    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 ListAgentImages API.

    Parameters

    Returns Promise<ListAgentImagesResponse>

    ListAgentImagesResponse

listAgents

  • Display the name of all the existing ODMS Agents in the server.

    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 ListAgents API.

    Parameters

    Returns Promise<ListAgentsResponse>

    ListAgentsResponse

listConnections

listExcludedObjects

listJobOutputs

listJobs

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

    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 ListJobs API.

    Parameters

    Returns Promise<ListJobsResponse>

    ListJobsResponse

listMigrationObjectTypes

listMigrationObjects

listMigrations

listWorkRequestErrors

listWorkRequestLogs

listWorkRequests

  • Lists the work requests in a compartment or for a specified 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 ListWorkRequests API.

    Parameters

    Returns Promise<ListWorkRequestsResponse>

    ListWorkRequestsResponse

removeMigrationObjects

resumeJob

retrieveSupportedPhases

shutdownCircuitBreaker

  • shutdownCircuitBreaker(): void

startMigration

updateAgent

  • Modifies the ODMS Agent represented by the given ODMS Agent 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 UpdateAgent API.

    Parameters

    Returns Promise<UpdateAgentResponse>

    UpdateAgentResponse

updateConnection

updateJob

  • Update Migration Job resource details.

    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 UpdateJob API.

    Parameters

    Returns Promise<UpdateJobResponse>

    UpdateJobResponse

updateMigration