Options
All
  • Public
  • Public/Protected
  • All
Menu

Class LockboxClient

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

  • LockboxClient

Constructors

constructor

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

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: LockboxWaiter

targetService

targetService: string = "Lockbox"

Static Protected endpointServiceName

endpointServiceName: string = ""

Static Protected serviceEndpointTemplate

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

  • Cancels 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 CancelWorkRequest API.

    Parameters

    Returns Promise<CancelWorkRequestResponse>

    CancelWorkRequestResponse

changeApprovalTemplateCompartment

  • Moves an ApprovalTemplate 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 ChangeApprovalTemplateCompartment API.

    Parameters

    Returns Promise<ChangeApprovalTemplateCompartmentResponse>

    ChangeApprovalTemplateCompartmentResponse

changeLockboxCompartment

  • Moves a Lockbox 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 ChangeLockboxCompartment API.

    Parameters

    Returns Promise<ChangeLockboxCompartmentResponse>

    ChangeLockboxCompartmentResponse

close

  • close(): void

createAccessRequest

createApprovalTemplate

createLockbox

  • Creates a new Lockbox.

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

    Parameters

    Returns Promise<CreateLockboxResponse>

    CreateLockboxResponse

createWaiters

  • createWaiters(config?: common.WaiterConfiguration): LockboxWaiter
  • Creates a new LockboxWaiter for resources for this service.

    Parameters

    • Optional config: common.WaiterConfiguration

      The waiter configuration for termination and delay strategy

    Returns LockboxWaiter

    The service waiters.

deleteApprovalTemplate

  • Deletes an ApprovalTemplate 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 DeleteApprovalTemplate API.

    Parameters

    Returns Promise<DeleteApprovalTemplateResponse>

    DeleteApprovalTemplateResponse

deleteLockbox

  • Deletes a Lockbox 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 DeleteLockbox API.

    Parameters

    Returns Promise<DeleteLockboxResponse>

    DeleteLockboxResponse

exportAccessRequests

  • Exports a list of AccessRequestSummary objects within a compartment and during a specified time range in text format. You can filter the results by problem severity.

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

    Parameters

    Returns Promise<ExportAccessRequestsResponse>

    ExportAccessRequestsResponse

getAccessMaterials

  • Retrieves the access credential/material associated with the access 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 GetAccessMaterials API.

    Parameters

    Returns Promise<GetAccessMaterialsResponse>

    GetAccessMaterialsResponse

getAccessRequest

  • Retrieves an access request identified by the access request 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 GetAccessRequest API.

    Parameters

    Returns Promise<GetAccessRequestResponse>

    GetAccessRequestResponse

getAccessRequestInternal

  • Retrieves an access request identified by the access request ID for internal use. 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 GetAccessRequestInternal API.

    Parameters

    Returns Promise<GetAccessRequestInternalResponse>

    GetAccessRequestInternalResponse

getApprovalTemplate

  • Retrieves an approval template identified by the approval template 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 GetApprovalTemplate API.

    Parameters

    Returns Promise<GetApprovalTemplateResponse>

    GetApprovalTemplateResponse

getLockbox

  • Gets a Lockbox 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 GetLockbox API.

    Parameters

    Returns Promise<GetLockboxResponse>

    GetLockboxResponse

getWaiters

getWorkRequest

  • Gets details 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

handleAccessRequest

listAccessRequests

  • Retrieves a list of AccessRequestSummary objects 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 ListAccessRequests API.

    Parameters

    Returns Promise<ListAccessRequestsResponse>

    ListAccessRequestsResponse

listApprovalTemplates

  • Retrieves a list of ApprovalTemplateSummary objects 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 ListApprovalTemplates API.

    Parameters

    Returns Promise<ListApprovalTemplatesResponse>

    ListApprovalTemplatesResponse

listLockboxes

  • Returns a list of Lockboxes.

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

    Parameters

    Returns Promise<ListLockboxesResponse>

    ListLockboxesResponse

listWorkRequestErrors

  • Returns a (paginated) list of errors for 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 ListWorkRequestErrors API.

    Parameters

    Returns Promise<ListWorkRequestErrorsResponse>

    ListWorkRequestErrorsResponse

listWorkRequestLogs

  • Returns a (paginated) list of logs for 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 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

shutdownCircuitBreaker

  • shutdownCircuitBreaker(): void

updateApprovalTemplate

updateLockbox

  • Updates the Lockbox 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 UpdateLockbox API.

    Parameters

    Returns Promise<UpdateLockboxResponse>

    UpdateLockboxResponse