Package com.oracle.bmc.healthchecks

Interface HealthChecks

  • All Superinterfaces:
    AutoCloseable
    All Known Implementing Classes:
    HealthChecksClient
    @Generated(value="OracleSDKGenerator",
           comments="API Version: 20180501")
public interface HealthChecks
extends AutoCloseable
    API for the Health Checks service.

    Use this API to manage endpoint probes and monitors. For more information, see Overview of the Health Checks Service.

    This service client uses CircuitBreakerUtils.DEFAULT_CIRCUIT_BREAKER for all the operations by default if no circuit breaker configuration is defined by the user.

    • Method Detail

      • refreshClient

        void refreshClient()
        Rebuilds the client from scratch.

        Useful to refresh certificates.

      • setEndpoint

        void setEndpoint​(String endpoint)
        Sets the endpoint to call (ex, https://www.example.com).
        Parameters:
        endpoint - The endpoint of the service.

      • getEndpoint

        String getEndpoint()
        Gets the set endpoint for REST call (ex, https://www.example.com)

      • setRegion

        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.

        Parameters:
        region - The region of the service.

      • setRegion

        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.

        Parameters:
        regionId - The public region ID.

      • useRealmSpecificEndpointTemplate

        void useRealmSpecificEndpointTemplate​(boolean realmSpecificEndpointTemplateEnabled)
        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 - flag to enable the use of realm specific endpoint template

      • changeHttpMonitorCompartment

        ChangeHttpMonitorCompartmentResponse changeHttpMonitorCompartment​(ChangeHttpMonitorCompartmentRequest request)
        Moves a monitor into a different compartment.

        When provided, If-Match is checked against ETag values of the resource.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/healthchecks/ChangeHttpMonitorCompartmentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ChangeHttpMonitorCompartment API.

      • changePingMonitorCompartment

        ChangePingMonitorCompartmentResponse changePingMonitorCompartment​(ChangePingMonitorCompartmentRequest request)
        Moves a monitor into a different compartment.

        When provided, If-Match is checked against ETag values of the resource.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/healthchecks/ChangePingMonitorCompartmentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ChangePingMonitorCompartment API.

      • createHttpMonitor

        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.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/healthchecks/CreateHttpMonitorExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateHttpMonitor API.

      • createOnDemandHttpProbe

        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.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/healthchecks/CreateOnDemandHttpProbeExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateOnDemandHttpProbe API.

      • createOnDemandPingProbe

        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.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/healthchecks/CreateOnDemandPingProbeExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateOnDemandPingProbe API.

      • createPingMonitor

        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.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/healthchecks/CreatePingMonitorExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreatePingMonitor API.

      • deleteHttpMonitor

        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.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/healthchecks/DeleteHttpMonitorExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteHttpMonitor API.

      • deletePingMonitor

        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.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/healthchecks/DeletePingMonitorExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeletePingMonitor API.

      • getHttpMonitor

        GetHttpMonitorResponse getHttpMonitor​(GetHttpMonitorRequest request)
        Gets the configuration for the specified monitor.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/healthchecks/GetHttpMonitorExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetHttpMonitor API.

      • getPingMonitor

        GetPingMonitorResponse getPingMonitor​(GetPingMonitorRequest request)
        Gets the configuration for the specified ping monitor.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/healthchecks/GetPingMonitorExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetPingMonitor API.

      • listHealthChecksVantagePoints

        ListHealthChecksVantagePointsResponse listHealthChecksVantagePoints​(ListHealthChecksVantagePointsRequest request)
        Gets information about all vantage points available to the user.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/healthchecks/ListHealthChecksVantagePointsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListHealthChecksVantagePoints API.

      • listHttpMonitors

        ListHttpMonitorsResponse listHttpMonitors​(ListHttpMonitorsRequest request)
        Gets a list of HTTP monitors.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/healthchecks/ListHttpMonitorsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListHttpMonitors API.

      • listHttpProbeResults

        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.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/healthchecks/ListHttpProbeResultsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListHttpProbeResults API.

      • listPingMonitors

        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.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/healthchecks/ListPingMonitorsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListPingMonitors API.

      • listPingProbeResults

        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`.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/healthchecks/ListPingProbeResultsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListPingProbeResults API.

      • updateHttpMonitor

        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.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/healthchecks/UpdateHttpMonitorExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateHttpMonitor API.

      • updatePingMonitor

        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.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/healthchecks/UpdatePingMonitorExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdatePingMonitor API.

      • getPaginators

        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.

        Returns:
        The service paginators.