Options
All
  • Public
  • Public/Protected
  • All
Menu

Class VnMonitoringClient

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

  • VnMonitoringClient

Constructors

constructor

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

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

Static Protected endpointServiceName

endpointServiceName: string = ""

Static Protected serviceEndpointTemplate

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

changePathAnalyzerTestCompartment

close

  • close(): void

createPathAnalyzerTest

createWaiters

  • Creates a new VnMonitoringWaiter for resources for this service.

    Parameters

    • Optional config: common.WaiterConfiguration

      The waiter configuration for termination and delay strategy

    Returns VnMonitoringWaiter

    The service waiters.

deletePathAnalyzerTest

getPathAnalysis

  • Use this method to initiate a Network Path Analyzer analysis. This method returns an opc-work-request-id, and you can poll the status of the work request until it either fails or succeeds.

    If the work request status is successful, use {@link #listWorkRequestResults(ListWorkRequestResultsRequest) listWorkRequestResults} with the work request ID to ask for the successful analysis results. If the work request status is failed, use {@link #listWorkRequestErrors(ListWorkRequestErrorsRequest) listWorkRequestErrors} with the work request ID to ask for the analysis failure information. The information returned from either of these methods can be used to build a final report.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetPathAnalysis API.

    Parameters

    Returns Promise<GetPathAnalysisResponse>

    GetPathAnalysisResponse

getPathAnalyzerTest

getWaiters

getWorkRequest

listPathAnalyzerTests

listWorkRequestErrors

  • Returns a (paginated) list of errors for the work request with the given ID. This information is used to build the final report output.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListWorkRequestErrors API.

    Parameters

    Returns Promise<ListWorkRequestErrorsResponse>

    ListWorkRequestErrorsResponse

listWorkRequestLogs

listWorkRequestResults

  • Returns a (paginated) list of results for a successful work request. This information is used to build the final report output.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListWorkRequestResults API.

    Parameters

    Returns Promise<ListWorkRequestResultsResponse>

    ListWorkRequestResultsResponse

listWorkRequests

shutdownCircuitBreaker

  • shutdownCircuitBreaker(): void

updatePathAnalyzerTest