Options
All
  • Public
  • Public/Protected
  • All
Menu

Class DisasterRecoveryClient

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

  • DisasterRecoveryClient

Constructors

constructor

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

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 = "DisasterRecovery"

Static Protected endpointServiceName

endpointServiceName: string = ""

Static Protected serviceEndpointTemplate

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

associateDrProtectionGroup

  • Create an association between the DR protection group identified by drProtectionGroupId and another DR protection group.

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

    Parameters

    Returns Promise<AssociateDrProtectionGroupResponse>

    AssociateDrProtectionGroupResponse

cancelDrPlanExecution

cancelWorkRequest

changeDrProtectionGroupCompartment

close

  • close(): void

createDrPlan

  • Create a DR plan of the specified DR plan type. 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 CreateDrPlan API.

    Parameters

    Returns Promise<CreateDrPlanResponse>

    CreateDrPlanResponse

createDrPlanExecution

createDrProtectionGroup

createWaiters

deleteDrPlan

  • Delete the DR plan identified by drPlanId. 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 DeleteDrPlan API.

    Parameters

    Returns Promise<DeleteDrPlanResponse>

    DeleteDrPlanResponse

deleteDrPlanExecution

deleteDrProtectionGroup

disassociateDrProtectionGroup

  • Delete the association between the DR protection group identified by drProtectionGroupId. and its peer DR protection group.

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

    Parameters

    Returns Promise<DisassociateDrProtectionGroupResponse>

    DisassociateDrProtectionGroupResponse

getDrPlan

  • Get details for the DR plan identified by drPlanId. 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 GetDrPlan API.

    Parameters

    Returns Promise<GetDrPlanResponse>

    GetDrPlanResponse

getDrPlanExecution

  • Get details for the DR plan execution identified by drPlanExecutionId. 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 GetDrPlanExecution API.

    Parameters

    Returns Promise<GetDrPlanExecutionResponse>

    GetDrPlanExecutionResponse

getDrProtectionGroup

getWaiters

getWorkRequest

  • Get the status of the work request identified by workRequestId. 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

ignoreDrPlanExecution

  • Ignore the failed group or step in DR plan execution identified by drPlanExecutionId and resume execution. 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 IgnoreDrPlanExecution API.

    Parameters

    Returns Promise<IgnoreDrPlanExecutionResponse>

    IgnoreDrPlanExecutionResponse

listDrPlanExecutions

listDrPlans

  • Get a summary list of all DR plans for a DR protection group. 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 ListDrPlans API.

    Parameters

    Returns Promise<ListDrPlansResponse>

    ListDrPlansResponse

listDrProtectionGroups

listWorkRequestErrors

  • Get a list of work request errors for the work request identified by workRequestId.

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

    Parameters

    Returns Promise<ListWorkRequestErrorsResponse>

    ListWorkRequestErrorsResponse

listWorkRequestLogs

listWorkRequests

pauseDrPlanExecution

resumeDrPlanExecution

retryDrPlanExecution

  • Retry the failed group or step in DR plan execution identified by drPlanExecutionId and resume execution. 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 RetryDrPlanExecution API.

    Parameters

    Returns Promise<RetryDrPlanExecutionResponse>

    RetryDrPlanExecutionResponse

shutdownCircuitBreaker

  • shutdownCircuitBreaker(): void

updateDrPlan

  • Update the DR plan identified by drPlanId. 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 UpdateDrPlan API.

    Parameters

    Returns Promise<UpdateDrPlanResponse>

    UpdateDrPlanResponse

updateDrPlanExecution

updateDrProtectionGroup

updateDrProtectionGroupRole