com.oracle.bmc.healthchecks.HealthChecksAsync Maven / Gradle / Ivy
Show all versions of oci-java-sdk-shaded-full Show documentation
/**
* Copyright (c) 2016, 2024, Oracle and/or its affiliates. All rights reserved.
* This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.
*/
package com.oracle.bmc.healthchecks;
import com.oracle.bmc.healthchecks.requests.*;
import com.oracle.bmc.healthchecks.responses.*;
/**
* 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](https://docs.cloud.oracle.com/iaas/Content/HealthChecks/Concepts/healthchecks.htm).
*/
@jakarta.annotation.Generated(value = "OracleSDKGenerator", comments = "API Version: 20180501")
public interface HealthChecksAsync extends AutoCloseable {
/** Rebuilds the client from scratch. Useful to refresh certificates. */
void refreshClient();
/**
* Sets the endpoint to call (ex, https://www.example.com).
*
* @param endpoint The endpoint of the serice.
*/
void setEndpoint(String endpoint);
/** Gets the set endpoint for REST call (ex, https://www.example.com) */
String getEndpoint();
/**
* Sets the region to call (ex, Region.US_PHOENIX_1).
*
* Note, this will call {@link #setEndpoint(String) setEndpoint} after resolving the
* endpoint. If the service is not available in this region, however, an
* IllegalArgumentException will be raised.
*
* @param region The region of the service.
*/
void setRegion(com.oracle.bmc.Region region);
/**
* 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 {@link
* #setRegion(Region) setRegion}.
*
*
If no known Region could be determined, it will create an endpoint based on the default
* endpoint format ({@link com.oracle.bmc.Region#formatDefaultRegionEndpoint(Service, String)}
* and then call {@link #setEndpoint(String) setEndpoint}.
*
* @param regionId The public region ID.
*/
void setRegion(String regionId);
/**
* 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"
*
* @param realmSpecificEndpointTemplateEnabled flag to enable the use of realm specific endpoint
* template
*/
void useRealmSpecificEndpointTemplate(boolean realmSpecificEndpointTemplateEnabled);
/**
* Moves a monitor into a different compartment. When provided, `If-Match` is checked against
* ETag values of the resource.
*
* @param request The request object containing the details to send
* @param handler The request handler to invoke upon completion, may be null.
* @return A Future that can be used to get the response if no AsyncHandler was provided. Note,
* if you provide an AsyncHandler and use the Future, some types of responses (like
* java.io.InputStream) may not be able to be read in both places as the underlying stream
* may only be consumed once.
*/
java.util.concurrent.Future changeHttpMonitorCompartment(
ChangeHttpMonitorCompartmentRequest request,
com.oracle.bmc.responses.AsyncHandler<
ChangeHttpMonitorCompartmentRequest,
ChangeHttpMonitorCompartmentResponse>
handler);
/**
* Moves a monitor into a different compartment. When provided, `If-Match` is checked against
* ETag values of the resource.
*
* @param request The request object containing the details to send
* @param handler The request handler to invoke upon completion, may be null.
* @return A Future that can be used to get the response if no AsyncHandler was provided. Note,
* if you provide an AsyncHandler and use the Future, some types of responses (like
* java.io.InputStream) may not be able to be read in both places as the underlying stream
* may only be consumed once.
*/
java.util.concurrent.Future changePingMonitorCompartment(
ChangePingMonitorCompartmentRequest request,
com.oracle.bmc.responses.AsyncHandler<
ChangePingMonitorCompartmentRequest,
ChangePingMonitorCompartmentResponse>
handler);
/**
* 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`.
*
* @param request The request object containing the details to send
* @param handler The request handler to invoke upon completion, may be null.
* @return A Future that can be used to get the response if no AsyncHandler was provided. Note,
* if you provide an AsyncHandler and use the Future, some types of responses (like
* java.io.InputStream) may not be able to be read in both places as the underlying stream
* may only be consumed once.
*/
java.util.concurrent.Future createHttpMonitor(
CreateHttpMonitorRequest request,
com.oracle.bmc.responses.AsyncHandler<
CreateHttpMonitorRequest, CreateHttpMonitorResponse>
handler);
/**
* 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.
*
* @param request The request object containing the details to send
* @param handler The request handler to invoke upon completion, may be null.
* @return A Future that can be used to get the response if no AsyncHandler was provided. Note,
* if you provide an AsyncHandler and use the Future, some types of responses (like
* java.io.InputStream) may not be able to be read in both places as the underlying stream
* may only be consumed once.
*/
java.util.concurrent.Future createOnDemandHttpProbe(
CreateOnDemandHttpProbeRequest request,
com.oracle.bmc.responses.AsyncHandler<
CreateOnDemandHttpProbeRequest, CreateOnDemandHttpProbeResponse>
handler);
/**
* 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.
*
* @param request The request object containing the details to send
* @param handler The request handler to invoke upon completion, may be null.
* @return A Future that can be used to get the response if no AsyncHandler was provided. Note,
* if you provide an AsyncHandler and use the Future, some types of responses (like
* java.io.InputStream) may not be able to be read in both places as the underlying stream
* may only be consumed once.
*/
java.util.concurrent.Future createOnDemandPingProbe(
CreateOnDemandPingProbeRequest request,
com.oracle.bmc.responses.AsyncHandler<
CreateOnDemandPingProbeRequest, CreateOnDemandPingProbeResponse>
handler);
/**
* 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`.
*
* @param request The request object containing the details to send
* @param handler The request handler to invoke upon completion, may be null.
* @return A Future that can be used to get the response if no AsyncHandler was provided. Note,
* if you provide an AsyncHandler and use the Future, some types of responses (like
* java.io.InputStream) may not be able to be read in both places as the underlying stream
* may only be consumed once.
*/
java.util.concurrent.Future createPingMonitor(
CreatePingMonitorRequest request,
com.oracle.bmc.responses.AsyncHandler<
CreatePingMonitorRequest, CreatePingMonitorResponse>
handler);
/**
* Deletes the HTTP monitor and its configuration. All future probes of this monitor are
* stopped. Results associated with the monitor are not deleted.
*
* @param request The request object containing the details to send
* @param handler The request handler to invoke upon completion, may be null.
* @return A Future that can be used to get the response if no AsyncHandler was provided. Note,
* if you provide an AsyncHandler and use the Future, some types of responses (like
* java.io.InputStream) may not be able to be read in both places as the underlying stream
* may only be consumed once.
*/
java.util.concurrent.Future deleteHttpMonitor(
DeleteHttpMonitorRequest request,
com.oracle.bmc.responses.AsyncHandler<
DeleteHttpMonitorRequest, DeleteHttpMonitorResponse>
handler);
/**
* Deletes the ping monitor and its configuration. All future probes of this monitor are
* stopped. Results associated with the monitor are not deleted.
*
* @param request The request object containing the details to send
* @param handler The request handler to invoke upon completion, may be null.
* @return A Future that can be used to get the response if no AsyncHandler was provided. Note,
* if you provide an AsyncHandler and use the Future, some types of responses (like
* java.io.InputStream) may not be able to be read in both places as the underlying stream
* may only be consumed once.
*/
java.util.concurrent.Future deletePingMonitor(
DeletePingMonitorRequest request,
com.oracle.bmc.responses.AsyncHandler<
DeletePingMonitorRequest, DeletePingMonitorResponse>
handler);
/**
* Gets the configuration for the specified monitor.
*
* @param request The request object containing the details to send
* @param handler The request handler to invoke upon completion, may be null.
* @return A Future that can be used to get the response if no AsyncHandler was provided. Note,
* if you provide an AsyncHandler and use the Future, some types of responses (like
* java.io.InputStream) may not be able to be read in both places as the underlying stream
* may only be consumed once.
*/
java.util.concurrent.Future getHttpMonitor(
GetHttpMonitorRequest request,
com.oracle.bmc.responses.AsyncHandler
handler);
/**
* Gets the configuration for the specified ping monitor.
*
* @param request The request object containing the details to send
* @param handler The request handler to invoke upon completion, may be null.
* @return A Future that can be used to get the response if no AsyncHandler was provided. Note,
* if you provide an AsyncHandler and use the Future, some types of responses (like
* java.io.InputStream) may not be able to be read in both places as the underlying stream
* may only be consumed once.
*/
java.util.concurrent.Future getPingMonitor(
GetPingMonitorRequest request,
com.oracle.bmc.responses.AsyncHandler
handler);
/**
* Gets information about all vantage points available to the user.
*
* @param request The request object containing the details to send
* @param handler The request handler to invoke upon completion, may be null.
* @return A Future that can be used to get the response if no AsyncHandler was provided. Note,
* if you provide an AsyncHandler and use the Future, some types of responses (like
* java.io.InputStream) may not be able to be read in both places as the underlying stream
* may only be consumed once.
*/
java.util.concurrent.Future
listHealthChecksVantagePoints(
ListHealthChecksVantagePointsRequest request,
com.oracle.bmc.responses.AsyncHandler<
ListHealthChecksVantagePointsRequest,
ListHealthChecksVantagePointsResponse>
handler);
/**
* Gets a list of HTTP monitors.
*
* @param request The request object containing the details to send
* @param handler The request handler to invoke upon completion, may be null.
* @return A Future that can be used to get the response if no AsyncHandler was provided. Note,
* if you provide an AsyncHandler and use the Future, some types of responses (like
* java.io.InputStream) may not be able to be read in both places as the underlying stream
* may only be consumed once.
*/
java.util.concurrent.Future listHttpMonitors(
ListHttpMonitorsRequest request,
com.oracle.bmc.responses.AsyncHandler
handler);
/**
* 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.
*
* @param request The request object containing the details to send
* @param handler The request handler to invoke upon completion, may be null.
* @return A Future that can be used to get the response if no AsyncHandler was provided. Note,
* if you provide an AsyncHandler and use the Future, some types of responses (like
* java.io.InputStream) may not be able to be read in both places as the underlying stream
* may only be consumed once.
*/
java.util.concurrent.Future listHttpProbeResults(
ListHttpProbeResultsRequest request,
com.oracle.bmc.responses.AsyncHandler<
ListHttpProbeResultsRequest, ListHttpProbeResultsResponse>
handler);
/**
* 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.
*
* @param request The request object containing the details to send
* @param handler The request handler to invoke upon completion, may be null.
* @return A Future that can be used to get the response if no AsyncHandler was provided. Note,
* if you provide an AsyncHandler and use the Future, some types of responses (like
* java.io.InputStream) may not be able to be read in both places as the underlying stream
* may only be consumed once.
*/
java.util.concurrent.Future listPingMonitors(
ListPingMonitorsRequest request,
com.oracle.bmc.responses.AsyncHandler
handler);
/**
* 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`.
*
* @param request The request object containing the details to send
* @param handler The request handler to invoke upon completion, may be null.
* @return A Future that can be used to get the response if no AsyncHandler was provided. Note,
* if you provide an AsyncHandler and use the Future, some types of responses (like
* java.io.InputStream) may not be able to be read in both places as the underlying stream
* may only be consumed once.
*/
java.util.concurrent.Future listPingProbeResults(
ListPingProbeResultsRequest request,
com.oracle.bmc.responses.AsyncHandler<
ListPingProbeResultsRequest, ListPingProbeResultsResponse>
handler);
/**
* 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.
*
* @param request The request object containing the details to send
* @param handler The request handler to invoke upon completion, may be null.
* @return A Future that can be used to get the response if no AsyncHandler was provided. Note,
* if you provide an AsyncHandler and use the Future, some types of responses (like
* java.io.InputStream) may not be able to be read in both places as the underlying stream
* may only be consumed once.
*/
java.util.concurrent.Future updateHttpMonitor(
UpdateHttpMonitorRequest request,
com.oracle.bmc.responses.AsyncHandler<
UpdateHttpMonitorRequest, UpdateHttpMonitorResponse>
handler);
/**
* 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.
*
* @param request The request object containing the details to send
* @param handler The request handler to invoke upon completion, may be null.
* @return A Future that can be used to get the response if no AsyncHandler was provided. Note,
* if you provide an AsyncHandler and use the Future, some types of responses (like
* java.io.InputStream) may not be able to be read in both places as the underlying stream
* may only be consumed once.
*/
java.util.concurrent.Future updatePingMonitor(
UpdatePingMonitorRequest request,
com.oracle.bmc.responses.AsyncHandler<
UpdatePingMonitorRequest, UpdatePingMonitorResponse>
handler);
}