Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ApmSyntheticClient

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

  • ApmSyntheticClient

Constructors

constructor

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

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

targetService

targetService: string = "ApmSynthetic"

Static Protected endpointServiceName

endpointServiceName: string = ""

Static Protected serviceEndpointTemplate

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

aggregateNetworkData

close

  • close(): void

createDedicatedVantagePoint

createMonitor

createOnPremiseVantagePoint

createScript

  • Creates a new script.

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

    Parameters

    Returns Promise<CreateScriptResponse>

    CreateScriptResponse

createWorker

  • Registers a new worker.

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

    Parameters

    Returns Promise<CreateWorkerResponse>

    CreateWorkerResponse

deleteDedicatedVantagePoint

deleteMonitor

  • Deletes the specified monitor. 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 DeleteMonitor API.

    Parameters

    Returns Promise<DeleteMonitorResponse>

    DeleteMonitorResponse

deleteOnPremiseVantagePoint

deleteScript

  • Deletes the specified script. 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 DeleteScript API.

    Parameters

    Returns Promise<DeleteScriptResponse>

    DeleteScriptResponse

deleteWorker

  • Deregisters the specified worker. 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 DeleteWorker API.

    Parameters

    Returns Promise<DeleteWorkerResponse>

    DeleteWorkerResponse

getDedicatedVantagePoint

getMonitor

  • Gets the configuration of the monitor identified by the 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 GetMonitor API.

    Parameters

    Returns Promise<GetMonitorResponse>

    GetMonitorResponse

getMonitorResult

  • Gets the results for a specific execution of a monitor identified by OCID. The results are in a HAR file, Screenshot, Console Log or Network details.

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

    Parameters

    Returns Promise<GetMonitorResultResponse>

    GetMonitorResultResponse

getOnPremiseVantagePoint

getScript

  • Gets the configuration of the script identified by the 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 GetScript API.

    Parameters

    Returns Promise<GetScriptResponse>

    GetScriptResponse

getWorker

  • Gets the details of the worker identified by the 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 GetWorker API.

    Parameters

    Returns Promise<GetWorkerResponse>

    GetWorkerResponse

listDedicatedVantagePoints

listMonitors

  • Returns a list of monitors.

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

    Parameters

    Returns Promise<ListMonitorsResponse>

    ListMonitorsResponse

listOnPremiseVantagePoints

listPublicVantagePoints

listScripts

  • Returns a list of scripts.

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

    Parameters

    Returns Promise<ListScriptsResponse>

    ListScriptsResponse

listWorkers

  • Returns a list of workers.

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

    Parameters

    Returns Promise<ListWorkersResponse>

    ListWorkersResponse

shutdownCircuitBreaker

  • shutdownCircuitBreaker(): void

updateDedicatedVantagePoint

updateMonitor

updateOnPremiseVantagePoint

updateScript

updateWorker