@Generated(value="OracleSDKGenerator", comments="API Version: 20180501") public interface HealthChecks extends AutoCloseable
Modifier and Type | Method and Description |
---|---|
CreateHttpMonitorResponse |
createHttpMonitor(CreateHttpMonitorRequest request)
Creates an HTTP monitor.
|
CreateOnDemandHttpProbeResponse |
createOnDemandHttpProbe(CreateOnDemandHttpProbeRequest request)
Creates an on-demand HTTP probe.
|
CreateOnDemandPingProbeResponse |
createOnDemandPingProbe(CreateOnDemandPingProbeRequest request)
Creates an on-demand ping probe.
|
CreatePingMonitorResponse |
createPingMonitor(CreatePingMonitorRequest request)
Creates a ping monitor.
|
DeleteHttpMonitorResponse |
deleteHttpMonitor(DeleteHttpMonitorRequest request)
Deletes the HTTP monitor and its configuration.
|
DeletePingMonitorResponse |
deletePingMonitor(DeletePingMonitorRequest request)
Deletes the ping monitor and its configuration.
|
GetHttpMonitorResponse |
getHttpMonitor(GetHttpMonitorRequest request)
Gets the configuration for the specified monitor.
|
HealthChecksPaginators |
getPaginators()
Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
|
GetPingMonitorResponse |
getPingMonitor(GetPingMonitorRequest request)
Gets the configuration for the specified ping monitor.
|
ListHealthChecksVantagePointsResponse |
listHealthChecksVantagePoints(ListHealthChecksVantagePointsRequest request)
Gets information about all vantage points available to the user.
|
ListHttpMonitorsResponse |
listHttpMonitors(ListHttpMonitorsRequest request)
Gets a list of HTTP monitors.
|
ListHttpProbeResultsResponse |
listHttpProbeResults(ListHttpProbeResultsRequest request)
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. |
ListPingMonitorsResponse |
listPingMonitors(ListPingMonitorsRequest request)
Gets a list of configured ping monitors.
|
ListPingProbeResultsResponse |
listPingProbeResults(ListPingProbeResultsRequest request)
Returns the results for the specified probe, where the
probeConfigurationId is the OCID of either a monitor or an on-demand probe. |
void |
setEndpoint(String endpoint)
Sets the endpoint to call (ex, https://www.example.com).
|
void |
setRegion(Region region)
Sets the region to call (ex, Region.US_PHOENIX_1).
|
void |
setRegion(String regionId)
Sets the region to call (ex, ‘us-phoenix-1’).
|
UpdateHttpMonitorResponse |
updateHttpMonitor(UpdateHttpMonitorRequest request)
Updates the configuration of the specified HTTP monitor.
|
UpdatePingMonitorResponse |
updatePingMonitor(UpdatePingMonitorRequest request)
Updates the configuration of the specified ping monitor.
|
close
void setEndpoint(String endpoint)
Sets the endpoint to call (ex, https://www.example.com).
endpoint
- The endpoint of the service.void setRegion(Region region)
Sets the region to call (ex, Region.US_PHOENIX_1).
Note, this will call setEndpoint
after resolving the endpoint. If the service is not available in this Region, however, an IllegalArgumentException will be raised.
region
- The region of the service.void setRegion(String regionId)
Sets the region to call (ex, ‘us-phoenix-1’).
Note, this will first try to map the region ID to a known Region and call setRegion
.
If no known Region could be determined, it will create an endpoint based on the default endpoint format (Region.formatDefaultRegionEndpoint(Service, String)
and then call setEndpoint
.
regionId
- The public region ID.CreateHttpMonitorResponse createHttpMonitor(CreateHttpMonitorRequest request)
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
.
request
- The request object containing the details to sendBmcException
- when an error occurs.CreateOnDemandHttpProbeResponse createOnDemandHttpProbe(CreateOnDemandHttpProbeRequest request)
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.
request
- The request object containing the details to sendBmcException
- when an error occurs.CreateOnDemandPingProbeResponse createOnDemandPingProbe(CreateOnDemandPingProbeRequest request)
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.
request
- The request object containing the details to sendBmcException
- when an error occurs.CreatePingMonitorResponse createPingMonitor(CreatePingMonitorRequest request)
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
.
request
- The request object containing the details to sendBmcException
- when an error occurs.DeleteHttpMonitorResponse deleteHttpMonitor(DeleteHttpMonitorRequest request)
Deletes the HTTP monitor and its configuration. All future probes of this monitor are stopped. Results associated with the monitor are not deleted.
request
- The request object containing the details to sendBmcException
- when an error occurs.DeletePingMonitorResponse deletePingMonitor(DeletePingMonitorRequest request)
Deletes the ping monitor and its configuration. All future probes of this monitor are stopped. Results associated with the monitor are not deleted.
request
- The request object containing the details to sendBmcException
- when an error occurs.GetHttpMonitorResponse getHttpMonitor(GetHttpMonitorRequest request)
Gets the configuration for the specified monitor.
request
- The request object containing the details to sendBmcException
- when an error occurs.GetPingMonitorResponse getPingMonitor(GetPingMonitorRequest request)
Gets the configuration for the specified ping monitor.
request
- The request object containing the details to sendBmcException
- when an error occurs.ListHealthChecksVantagePointsResponse listHealthChecksVantagePoints(ListHealthChecksVantagePointsRequest request)
Gets information about all vantage points available to the user.
request
- The request object containing the details to sendBmcException
- when an error occurs.ListHttpMonitorsResponse listHttpMonitors(ListHttpMonitorsRequest request)
Gets a list of HTTP monitors.
request
- The request object containing the details to sendBmcException
- when an error occurs.ListHttpProbeResultsResponse listHttpProbeResults(ListHttpProbeResultsRequest request)
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.
request
- The request object containing the details to sendBmcException
- when an error occurs.ListPingMonitorsResponse listPingMonitors(ListPingMonitorsRequest request)
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.
request
- The request object containing the details to sendBmcException
- when an error occurs.ListPingProbeResultsResponse listPingProbeResults(ListPingProbeResultsRequest request)
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
.
request
- The request object containing the details to sendBmcException
- when an error occurs.UpdateHttpMonitorResponse updateHttpMonitor(UpdateHttpMonitorRequest request)
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.
request
- The request object containing the details to sendBmcException
- when an error occurs.UpdatePingMonitorResponse updatePingMonitor(UpdatePingMonitorRequest request)
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.
request
- The request object containing the details to sendBmcException
- when an error occurs.HealthChecksPaginators getPaginators()
Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data. These paginators provide an Iterable
interface so that service responses, or resources/records, can be iterated through without having to manually deal with pagination and page tokens.
Copyright © 2016–2019. All rights reserved.