Options
All
  • Public
  • Public/Protected
  • All
Menu

Class HealthChecksClient

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

  • HealthChecksClient

Constructors

constructor

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

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

Static Protected endpointServiceName

endpointServiceName: string = ""

Static Protected serviceEndpointTemplate

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

changeHttpMonitorCompartment

changePingMonitorCompartment

close

  • close(): void

createHttpMonitor

  • Creates an HTTP monitor. Vantage points will be automatically selected if not specified, and probes will be initiated from each vantage point to each of the targets at the frequency specified by intervalInSeconds.

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

    Parameters

    Returns Promise<CreateHttpMonitorResponse>

    CreateHttpMonitorResponse

createOnDemandHttpProbe

  • Creates an on-demand HTTP probe. The location response header contains the URL for fetching the probe results.

    Note:* On-demand probe configurations are not saved.

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

    Parameters

    Returns Promise<CreateOnDemandHttpProbeResponse>

    CreateOnDemandHttpProbeResponse

createOnDemandPingProbe

  • Creates an on-demand ping probe. The location response header contains the URL for fetching probe results.

    Note:* The on-demand probe configuration is not saved.

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

    Parameters

    Returns Promise<CreateOnDemandPingProbeResponse>

    CreateOnDemandPingProbeResponse

createPingMonitor

  • Creates a ping monitor. Vantage points will be automatically selected if not specified, and probes will be initiated from each vantage point to each of the targets at the frequency specified by intervalInSeconds.

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

    Parameters

    Returns Promise<CreatePingMonitorResponse>

    CreatePingMonitorResponse

deleteHttpMonitor

  • Deletes the HTTP monitor and its configuration. All future probes of this monitor are stopped. Results associated with the monitor are not deleted.

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

    Parameters

    Returns Promise<DeleteHttpMonitorResponse>

    DeleteHttpMonitorResponse

deletePingMonitor

  • Deletes the ping monitor and its configuration. All future probes of this monitor are stopped. Results associated with the monitor are not deleted.

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

    Parameters

    Returns Promise<DeletePingMonitorResponse>

    DeletePingMonitorResponse

getHttpMonitor

getPingMonitor

listAllHealthChecksVantagePoints

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

    Parameters

    Returns AsyncIterableIterator<HealthChecksVantagePointSummary>

listAllHealthChecksVantagePointsResponses

listAllHttpMonitors

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

    Parameters

    Returns AsyncIterableIterator<HttpMonitorSummary>

listAllHttpMonitorsResponses

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

    Parameters

    Returns AsyncIterableIterator<ListHttpMonitorsResponse>

listAllHttpProbeResults

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

    Parameters

    Returns AsyncIterableIterator<HttpProbeResultSummary>

listAllHttpProbeResultsResponses

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

    Parameters

    Returns AsyncIterableIterator<ListHttpProbeResultsResponse>

listAllPingMonitors

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

    Parameters

    Returns AsyncIterableIterator<PingMonitorSummary>

listAllPingMonitorsResponses

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

    Parameters

    Returns AsyncIterableIterator<ListPingMonitorsResponse>

listAllPingProbeResults

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

    Parameters

    Returns AsyncIterableIterator<PingProbeResultSummary>

listAllPingProbeResultsResponses

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

    Parameters

    Returns AsyncIterableIterator<ListPingProbeResultsResponse>

listHealthChecksVantagePoints

listHealthChecksVantagePointsRecordIterator

listHealthChecksVantagePointsResponseIterator

listHttpMonitors

listHttpMonitorsRecordIterator

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

    Parameters

    Returns AsyncIterableIterator<HttpMonitorSummary>

listHttpMonitorsResponseIterator

listHttpProbeResults

  • Gets the HTTP probe results for the specified probe or monitor, where the probeConfigurationId is the OCID of either a monitor or an on-demand probe.

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

    Parameters

    Returns Promise<ListHttpProbeResultsResponse>

    ListHttpProbeResultsResponse

listHttpProbeResultsRecordIterator

listHttpProbeResultsResponseIterator

listPingMonitors

  • Gets a list of configured ping monitors.

    Results are paginated based on `page` and `limit`. The `opc-next-page` header provides a URL for fetching the next page.

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

    Parameters

    Returns Promise<ListPingMonitorsResponse>

    ListPingMonitorsResponse

listPingMonitorsRecordIterator

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

    Parameters

    Returns AsyncIterableIterator<PingMonitorSummary>

listPingMonitorsResponseIterator

listPingProbeResults

  • Returns the results for the specified probe, where the probeConfigurationId is the OCID of either a monitor or an on-demand probe.

    Results are paginated based on `page` and `limit`. The `opc-next-page` header provides a URL for fetching the next page. Use `sortOrder` to set the order of the results. If `sortOrder` is unspecified, results are sorted in ascending order by `startTime`.

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

    Parameters

    Returns Promise<ListPingProbeResultsResponse>

    ListPingProbeResultsResponse

listPingProbeResultsRecordIterator

listPingProbeResultsResponseIterator

shutdownCircuitBreaker

  • shutdownCircuitBreaker(): void

updateHttpMonitor

  • Updates the configuration of the specified HTTP monitor. Only the fields specified in the request body will be updated; all other configuration properties will remain unchanged.

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

    Parameters

    Returns Promise<UpdateHttpMonitorResponse>

    UpdateHttpMonitorResponse

updatePingMonitor

  • Updates the configuration of the specified ping monitor. Only the fields specified in the request body will be updated; all other configuration properties will remain unchanged.

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

    Parameters

    Returns Promise<UpdatePingMonitorResponse>

    UpdatePingMonitorResponse