Options
All
  • Public
  • Public/Protected
  • All
Menu

Class DataSafeClient

Hierarchy

  • DataSafeClient

Constructors

constructor

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

Properties

Protected _circuitBreaker

_circuitBreaker: null = null

Protected _clientConfiguration

_clientConfiguration: ClientConfiguration

Protected _defaultHeaders

_defaultHeaders: any

Protected _endpoint

_endpoint: string = ""

Protected _httpClient

_httpClient: HttpClient

Protected _waiters

_waiters: DataSafeWaiter

Static Protected serviceEndpointTemplate

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

    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

Methods

activateTargetDatabase

changeDataSafePrivateEndpointCompartment

changeOnPremConnectorCompartment

changeTargetDatabaseCompartment

createDataSafePrivateEndpoint

createOnPremConnector

createTargetDatabase

createWaiters

  • Creates a new DataSafeWaiter for resources for this service.

    Parameters

    • Optional config: common.WaiterConfiguration

      The waiter configuration for termination and delay strategy

    Returns DataSafeWaiter

    The service waiters.

deactivateTargetDatabase

deleteDataSafePrivateEndpoint

deleteOnPremConnector

deleteTargetDatabase

downloadPrivilegeScript

enableDataSafeConfiguration

generateOnPremConnectorConfiguration

getDataSafeConfiguration

getDataSafePrivateEndpoint

getOnPremConnector

getTargetDatabase

getWaiters

getWorkRequest

listAllDataSafePrivateEndpoints

listAllDataSafePrivateEndpointsResponses

listAllOnPremConnectors

  • Creates a new async iterator which will iterate over the models.OnPremConnectorSummary objects contained in responses from the listOnPremConnectors operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<OnPremConnectorSummary>

listAllOnPremConnectorsResponses

listAllTargetDatabases

  • Creates a new async iterator which will iterate over the models.TargetDatabaseSummary objects contained in responses from the listTargetDatabases operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<TargetDatabaseSummary>

listAllTargetDatabasesResponses

listAllWorkRequestErrors

  • Creates a new async iterator which will iterate over the models.WorkRequestError objects contained in responses from the listWorkRequestErrors operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<WorkRequestError>

listAllWorkRequestErrorsResponses

listAllWorkRequestLogs

  • Creates a new async iterator which will iterate over the models.WorkRequestLogEntry objects contained in responses from the listWorkRequestLogs operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<WorkRequestLogEntry>

listAllWorkRequestLogsResponses

listAllWorkRequests

  • Creates a new async iterator which will iterate over the models.WorkRequestSummary objects contained in responses from the listWorkRequests operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<WorkRequestSummary>

listAllWorkRequestsResponses

listDataSafePrivateEndpoints

listOnPremConnectors

listTargetDatabases

listWorkRequestErrors

listWorkRequestLogs

listWorkRequests

updateDataSafePrivateEndpoint

updateOnPremConnector

updateOnPremConnectorWallet

updateTargetDatabase