Options
All
  • Public
  • Public/Protected
  • All
Menu

Class DatabaseRecoveryClient

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

  • DatabaseRecoveryClient

Constructors

constructor

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

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

Static Protected endpointServiceName

endpointServiceName: string = ""

Static Protected serviceEndpointTemplate

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

cancelProtectedDatabaseDeletion

  • Cancels the scheduled deletion of a protected database, and returns the protected database to an ACTIVE state. You can cancel the deletion only if the protected database is in the DELETE SCHEDULED state. 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 CancelProtectedDatabaseDeletion API.

    Parameters

    Returns Promise<CancelProtectedDatabaseDeletionResponse>

    CancelProtectedDatabaseDeletionResponse

changeProtectedDatabaseCompartment

  • Moves a protected database resource from the existing compartment to the specified 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 ChangeProtectedDatabaseCompartment API.

    Parameters

    Returns Promise<ChangeProtectedDatabaseCompartmentResponse>

    ChangeProtectedDatabaseCompartmentResponse

changeProtectionPolicyCompartment

  • Moves a protection policy resource from the existing compartment to the specified 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 ChangeProtectionPolicyCompartment API.

    Parameters

    Returns Promise<ChangeProtectionPolicyCompartmentResponse>

    ChangeProtectionPolicyCompartmentResponse

changeRecoveryServiceSubnetCompartment

  • Moves a recovery service subnet resource from the existing compartment to the specified 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 ChangeRecoveryServiceSubnetCompartment API.

    Parameters

    Returns Promise<ChangeRecoveryServiceSubnetCompartmentResponse>

    ChangeRecoveryServiceSubnetCompartmentResponse

close

  • close(): void

createProtectedDatabase

createProtectionPolicy

createRecoveryServiceSubnet

createWaiters

  • Creates a new DatabaseRecoveryWaiter for resources for this service.

    Parameters

    • Optional config: common.WaiterConfiguration

      The waiter configuration for termination and delay strategy

    Returns DatabaseRecoveryWaiter

    The service waiters.

deleteProtectedDatabase

  • Deletes a protected database based on the specified protected database 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 DeleteProtectedDatabase API.

    Parameters

    Returns Promise<DeleteProtectedDatabaseResponse>

    DeleteProtectedDatabaseResponse

deleteProtectionPolicy

  • Deletes a specified protection policy. You can delete custom policies only. Deleting a Oracle predefined policies will result in status code 405 Method Not Allowed.

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

    Parameters

    Returns Promise<DeleteProtectionPolicyResponse>

    DeleteProtectionPolicyResponse

deleteRecoveryServiceSubnet

fetchProtectedDatabaseConfiguration

  • Downloads the network service configuration file 'tnsnames.ora' for a specified protected database. Applies to user-defined recovery systems only. 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 FetchProtectedDatabaseConfiguration API.

    Parameters

    Returns Promise<FetchProtectedDatabaseConfigurationResponse>

    FetchProtectedDatabaseConfigurationResponse

getProtectedDatabase

  • Gets information about a specified protected database. 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 GetProtectedDatabase API.

    Parameters

    Returns Promise<GetProtectedDatabaseResponse>

    GetProtectedDatabaseResponse

getProtectionPolicy

  • Gets information about a specified protection policy. 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 GetProtectionPolicy API.

    Parameters

    Returns Promise<GetProtectionPolicyResponse>

    GetProtectionPolicyResponse

getRecoveryServiceSubnet

getWaiters

getWorkRequest

  • Gets the status of the work request based on the specified 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

listProtectedDatabases

  • Lists the protected databases based on the specified parameters.

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

    Parameters

    Returns Promise<ListProtectedDatabasesResponse>

    ListProtectedDatabasesResponse

listProtectionPolicies

  • Gets a list of protection policies based on the specified parameters.

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

    Parameters

    Returns Promise<ListProtectionPoliciesResponse>

    ListProtectionPoliciesResponse

listRecoveryServiceSubnets

listWorkRequestErrors

  • Return a (paginated) list of errors for a given work request.

    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

  • Return a (paginated) list of logs for a given work request.

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

    Parameters

    Returns Promise<ListWorkRequestLogsResponse>

    ListWorkRequestLogsResponse

listWorkRequests

  • Lists the work requests in a compartment.

    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

scheduleProtectedDatabaseDeletion

  • Defines a preferred schedule to delete a protected database after you terminate the source database. The default schedule is DELETE_AFTER_72_HOURS, so that the delete operation can occur 72 hours (3 days) after the source database is terminated. The alternate schedule is DELETE_AFTER_RETENTION_PERIOD. Specify this option if you want to delete a protected database only after the policy-defined backup retention period expires.

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

    Parameters

    Returns Promise<ScheduleProtectedDatabaseDeletionResponse>

    ScheduleProtectedDatabaseDeletionResponse

shutdownCircuitBreaker

  • shutdownCircuitBreaker(): void

updateProtectedDatabase

updateProtectionPolicy

updateRecoveryServiceSubnet