Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ApmDomainClient

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

  • ApmDomainClient

Constructors

constructor

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

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

targetService

targetService: string = "ApmDomain"

Static Protected endpointServiceName

endpointServiceName: string = ""

Static Protected serviceEndpointTemplate

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

changeApmDomainCompartment

  • Moves an APM domain into a different compartment. When provided, If-Match is checked against ETag values of the APM domain. 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 ChangeApmDomainCompartment API.

    Parameters

    Returns Promise<ChangeApmDomainCompartmentResponse>

    ChangeApmDomainCompartmentResponse

close

  • close(): void

createApmDomain

createWaiters

  • Creates a new ApmDomainWaiter for resources for this service.

    Parameters

    • Optional config: common.WaiterConfiguration

      The waiter configuration for termination and delay strategy

    Returns ApmDomainWaiter

    The service waiters.

deleteApmDomain

  • Deletes the specified APM domain asynchronously. The APM domain is placed in the 'Deleting' state and will stop accepting any operation requests. All resources associated with the APM domain are eventually recovered. Use the returned work request ID to track the progress of the background activity to complete deleting the APM domain.

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

    Parameters

    Returns Promise<DeleteApmDomainResponse>

    DeleteApmDomainResponse

generateDataKeys

  • Generates a set of new Data Keys for the specified APM domain with the specified names and types. These will be added to the existing set of Data Keys for the specified APM domain.

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

    Parameters

    Returns Promise<GenerateDataKeysResponse>

    GenerateDataKeysResponse

getApmDomain

  • Gets the details of the APM domain specified by OCID. 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 GetApmDomain API.

    Parameters

    Returns Promise<GetApmDomainResponse>

    GetApmDomainResponse

getWaiters

getWorkRequest

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

listAllApmDomainWorkRequests

  • NOTE: This function is deprecated in favor of listApmDomainWorkRequestsRecordIterator function. Creates a new async iterator which will iterate over the models.WorkRequest objects contained in responses from the listApmDomainWorkRequests operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<WorkRequest>

listAllApmDomainWorkRequestsResponses

listAllApmDomains

  • NOTE: This function is deprecated in favor of listApmDomainsRecordIterator function. Creates a new async iterator which will iterate over the models.ApmDomainSummary objects contained in responses from the listApmDomains operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ApmDomainSummary>

listAllApmDomainsResponses

  • NOTE: This function is deprecated in favor of listApmDomainsResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listApmDomains operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListApmDomainsResponse>

listAllWorkRequestErrors

  • NOTE: This function is deprecated in favor of listWorkRequestErrorsRecordIterator function. 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

  • NOTE: This function is deprecated in favor of listWorkRequestErrorsResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listWorkRequestErrors operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListWorkRequestErrorsResponse>

listAllWorkRequestLogs

  • NOTE: This function is deprecated in favor of listWorkRequestLogsRecordIterator function. 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

  • NOTE: This function is deprecated in favor of listWorkRequestLogsResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listWorkRequestLogs operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListWorkRequestLogsResponse>

listAllWorkRequests

  • NOTE: This function is deprecated in favor of listWorkRequestsRecordIterator function. Creates a new async iterator which will iterate over the models.WorkRequest objects contained in responses from the listWorkRequests operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<WorkRequest>

listAllWorkRequestsResponses

  • NOTE: This function is deprecated in favor of listWorkRequestsResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listWorkRequests operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListWorkRequestsResponse>

listApmDomainWorkRequests

listApmDomainWorkRequestsRecordIterator

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

    Parameters

    Returns AsyncIterableIterator<WorkRequest>

listApmDomainWorkRequestsResponseIterator

listApmDomains

  • Lists all APM domains for the specified tenant 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 ListApmDomains API.

    Parameters

    Returns Promise<ListApmDomainsResponse>

    ListApmDomainsResponse

listApmDomainsRecordIterator

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

    Parameters

    Returns AsyncIterableIterator<ApmDomainSummary>

listApmDomainsResponseIterator

listDataKeys

  • Lists all Data Keys for the specified APM domain. The caller may filter the list by specifying the 'dataKeyType' query parameter.

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

    Parameters

    Returns Promise<ListDataKeysResponse>

    ListDataKeysResponse

listWorkRequestErrors

listWorkRequestErrorsRecordIterator

listWorkRequestErrorsResponseIterator

listWorkRequestLogs

listWorkRequestLogsRecordIterator

listWorkRequestLogsResponseIterator

listWorkRequests

  • Returns a (paginated) list of work requests in a given 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

listWorkRequestsRecordIterator

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

    Parameters

    Returns AsyncIterableIterator<WorkRequest>

listWorkRequestsResponseIterator

removeDataKeys

  • Removes the set of specified Data Keys from the specified APM domain. Agents would no longer be able to use these data keys to upload to the APM domain once this operation is completed.

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

    Parameters

    Returns Promise<RemoveDataKeysResponse>

    RemoveDataKeysResponse

shutdownCircuitBreaker

  • shutdownCircuitBreaker(): void

updateApmDomain