com.oracle.bmc.healthchecks

Class HealthChecksAsyncClient

java.lang.Object

com.oracle.bmc.http.internal.BaseAsyncClient

com.oracle.bmc.healthchecks.HealthChecksAsyncClient

All Implemented Interfaces:

HealthChecksAsync, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20180501")
public class HealthChecksAsyncClient
extends BaseAsyncClient
implements HealthChecksAsync

Async client implementation for HealthChecks service.
There are two ways to use async client: 1. Use AsyncHandler: using AsyncHandler, if the response to the call is an InputStream, like getObject Api in object storage service, developers need to process the stream in AsyncHandler, and not anywhere else, because the stream will be closed right after the AsyncHandler is invoked.
2. Use Java Future: using Java Future, developers need to close the stream after they are done with the Java Future.
Accessing the result should be done in a mutually exclusive manner, either through the Future or the AsyncHandler, but not both. If the Future is used, the caller should pass in null as the AsyncHandler. If the AsyncHandler is used, it is still safe to use the Future to determine whether or not the request was completed via Future.isDone/isCancelled.
Please refer to https://github.com/oracle/oci-java-sdk/blob/master/bmc-examples/src/main/java/ResteasyClientWithObjectStorageExample.java

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HealthChecksAsyncClient.Builder Builder class for this client.

Field Summary

Fields

Modifier and Type	Field and Description
String	clientCommonLibraryVersion Compatible SDK version, provided by the codegen.
Optional<String>	minimumClientCommonLibraryVersionFromClient Minimum compatible SDK version, maybe provided by the codegen.
static Service	SERVICE Service instance for HealthChecks.

Constructor Summary

Constructors

Constructor and Description
HealthChecksAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory) Deprecated. Use the builder instead.
HealthChecksAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators) Deprecated. Use the builder instead.
HealthChecksAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint) Deprecated. Use the builder instead.
HealthChecksAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint) Deprecated. Use the builder instead.
HealthChecksAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider) Deprecated. Use the builder instead.
HealthChecksAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration) Deprecated. Use the builder instead.
HealthChecksAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator) Deprecated. Use the builder instead.

Method Summary

Modifier and Type	Method and Description
static HealthChecksAsyncClient.Builder	builder() Create a builder for this client.
Future<ChangeHttpMonitorCompartmentResponse>	changeHttpMonitorCompartment(ChangeHttpMonitorCompartmentRequest request, AsyncHandler<ChangeHttpMonitorCompartmentRequest,ChangeHttpMonitorCompartmentResponse> handler) Moves a monitor into a different compartment.
Future<ChangePingMonitorCompartmentResponse>	changePingMonitorCompartment(ChangePingMonitorCompartmentRequest request, AsyncHandler<ChangePingMonitorCompartmentRequest,ChangePingMonitorCompartmentResponse> handler) Moves a monitor into a different compartment.
protected <REQ extends BmcRequest<?>,RESP extends BmcResponse,RESP_BUILDER extends BmcResponse.Builder<RESP>> ClientCall<REQ,RESP,RESP_BUILDER>	clientCall(REQ request, Supplier<RESP_BUILDER> responseBuilder)
void	close()
Future<CreateHttpMonitorResponse>	createHttpMonitor(CreateHttpMonitorRequest request, AsyncHandler<CreateHttpMonitorRequest,CreateHttpMonitorResponse> handler) Creates an HTTP monitor.
Future<CreateOnDemandHttpProbeResponse>	createOnDemandHttpProbe(CreateOnDemandHttpProbeRequest request, AsyncHandler<CreateOnDemandHttpProbeRequest,CreateOnDemandHttpProbeResponse> handler) Creates an on-demand HTTP probe.
Future<CreateOnDemandPingProbeResponse>	createOnDemandPingProbe(CreateOnDemandPingProbeRequest request, AsyncHandler<CreateOnDemandPingProbeRequest,CreateOnDemandPingProbeResponse> handler) Creates an on-demand ping probe.
Future<CreatePingMonitorResponse>	createPingMonitor(CreatePingMonitorRequest request, AsyncHandler<CreatePingMonitorRequest,CreatePingMonitorResponse> handler) Creates a ping monitor.
Future<DeleteHttpMonitorResponse>	deleteHttpMonitor(DeleteHttpMonitorRequest request, AsyncHandler<DeleteHttpMonitorRequest,DeleteHttpMonitorResponse> handler) Deletes the HTTP monitor and its configuration.
Future<DeletePingMonitorResponse>	deletePingMonitor(DeletePingMonitorRequest request, AsyncHandler<DeletePingMonitorRequest,DeletePingMonitorResponse> handler) Deletes the ping monitor and its configuration.
String	getClientCommonLibraryVersion()
protected ClientConfigurator	getDefaultConfigurator()
String	getEndpoint()
Future<GetHttpMonitorResponse>	getHttpMonitor(GetHttpMonitorRequest request, AsyncHandler<GetHttpMonitorRequest,GetHttpMonitorResponse> handler) Gets the configuration for the specified monitor.
Optional<String>	getMinimumClientCommonLibraryVersionFromClient()
Future<GetPingMonitorResponse>	getPingMonitor(GetPingMonitorRequest request, AsyncHandler<GetPingMonitorRequest,GetPingMonitorResponse> handler) Gets the configuration for the specified ping monitor.
Future<ListHealthChecksVantagePointsResponse>	listHealthChecksVantagePoints(ListHealthChecksVantagePointsRequest request, AsyncHandler<ListHealthChecksVantagePointsRequest,ListHealthChecksVantagePointsResponse> handler) Gets information about all vantage points available to the user.
Future<ListHttpMonitorsResponse>	listHttpMonitors(ListHttpMonitorsRequest request, AsyncHandler<ListHttpMonitorsRequest,ListHttpMonitorsResponse> handler) Gets a list of HTTP monitors.
Future<ListHttpProbeResultsResponse>	listHttpProbeResults(ListHttpProbeResultsRequest request, AsyncHandler<ListHttpProbeResultsRequest,ListHttpProbeResultsResponse> 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.
Future<ListPingMonitorsResponse>	listPingMonitors(ListPingMonitorsRequest request, AsyncHandler<ListPingMonitorsRequest,ListPingMonitorsResponse> handler) Gets a list of configured ping monitors.
Future<ListPingProbeResultsResponse>	listPingProbeResults(ListPingProbeResultsRequest request, AsyncHandler<ListPingProbeResultsRequest,ListPingProbeResultsResponse> handler) Returns the results for the specified probe, where the probeConfigurationId is the OCID of either a monitor or an on-demand probe.
void	populateServiceParametersInEndpoint(String endpoint, Map<String,Object> requiredParametersMap) Populate the parameters in the endpoint with its corresponding value and update the base endpoint.
void	refreshClient() Rebuild the backing HttpClient.
void	setEndpoint(String endpoint)
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’).
void	updateBaseEndpoint(String endpoint) This method should be used for parameterized endpoint templates only.
Future<UpdateHttpMonitorResponse>	updateHttpMonitor(UpdateHttpMonitorRequest request, AsyncHandler<UpdateHttpMonitorRequest,UpdateHttpMonitorResponse> handler) Updates the configuration of the specified HTTP monitor.
Future<UpdatePingMonitorResponse>	updatePingMonitor(UpdatePingMonitorRequest request, AsyncHandler<UpdatePingMonitorRequest,UpdatePingMonitorResponse> handler) Updates the configuration of the specified ping monitor.
void	useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled) This method should be used to enable or disable the use of realm-specific endpoint template.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.oracle.bmc.healthchecks.HealthChecksAsync

getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

Methods inherited from interface java.lang.AutoCloseable

close

Field Detail

SERVICE

public static final Service SERVICE

Service instance for HealthChecks.

clientCommonLibraryVersion

public final String clientCommonLibraryVersion

Compatible SDK version, provided by the codegen.

minimumClientCommonLibraryVersionFromClient

public final Optional<String> minimumClientCommonLibraryVersionFromClient

Minimum compatible SDK version, maybe provided by the codegen.

Constructor Detail

HealthChecksAsyncClient

@Deprecated
public HealthChecksAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see HealthChecksAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

HealthChecksAsyncClient

@Deprecated
public HealthChecksAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                           ClientConfiguration configuration)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see HealthChecksAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

HealthChecksAsyncClient

@Deprecated
public HealthChecksAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                           ClientConfiguration configuration,
                                           ClientConfigurator clientConfigurator)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see HealthChecksAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

HealthChecksAsyncClient

@Deprecated
public HealthChecksAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                           ClientConfiguration configuration,
                                           ClientConfigurator clientConfigurator,
                                           RequestSignerFactory defaultRequestSignerFactory)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see HealthChecksAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

HealthChecksAsyncClient

@Deprecated
public HealthChecksAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                           ClientConfiguration configuration,
                                           ClientConfigurator clientConfigurator,
                                           RequestSignerFactory defaultRequestSignerFactory,
                                           List<ClientConfigurator> additionalClientConfigurators)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see HealthChecksAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

HealthChecksAsyncClient

@Deprecated
public HealthChecksAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                           ClientConfiguration configuration,
                                           ClientConfigurator clientConfigurator,
                                           RequestSignerFactory defaultRequestSignerFactory,
                                           List<ClientConfigurator> additionalClientConfigurators,
                                           String endpoint)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see HealthChecksAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

endpoint - ClientBuilderBase.endpoint(java.lang.String)

HealthChecksAsyncClient

@Deprecated
public HealthChecksAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                           ClientConfiguration configuration,
                                           ClientConfigurator clientConfigurator,
                                           RequestSignerFactory defaultRequestSignerFactory,
                                           Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                                           List<ClientConfigurator> additionalClientConfigurators,
                                           String endpoint)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see HealthChecksAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

endpoint - ClientBuilderBase.endpoint(java.lang.String)

signingStrategyRequestSignerFactories - ClientBuilderBase.signingStrategyRequestSignerFactories

Method Detail

builder

public static HealthChecksAsyncClient.Builder builder()

Create a builder for this client.

Returns:

builder

setRegion

public void setRegion(Region region)

Description copied from interface: HealthChecksAsync

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.

Specified by:

setRegion in interface HealthChecksAsync

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: HealthChecksAsync

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.

Specified by:

setRegion in interface HealthChecksAsync

Parameters:

regionId - The public region ID.

changeHttpMonitorCompartment

public Future<ChangeHttpMonitorCompartmentResponse> changeHttpMonitorCompartment(ChangeHttpMonitorCompartmentRequest request,
                                                                                 AsyncHandler<ChangeHttpMonitorCompartmentRequest,ChangeHttpMonitorCompartmentResponse> handler)

Description copied from interface: HealthChecksAsync

Moves a monitor into a different compartment. When provided, If-Match is checked against ETag values of the resource.

Specified by:

changeHttpMonitorCompartment in interface HealthChecksAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

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.

changePingMonitorCompartment

public Future<ChangePingMonitorCompartmentResponse> changePingMonitorCompartment(ChangePingMonitorCompartmentRequest request,
                                                                                 AsyncHandler<ChangePingMonitorCompartmentRequest,ChangePingMonitorCompartmentResponse> handler)

Description copied from interface: HealthChecksAsync

Moves a monitor into a different compartment. When provided, If-Match is checked against ETag values of the resource.

Specified by:

changePingMonitorCompartment in interface HealthChecksAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

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.

createHttpMonitor

public Future<CreateHttpMonitorResponse> createHttpMonitor(CreateHttpMonitorRequest request,
                                                           AsyncHandler<CreateHttpMonitorRequest,CreateHttpMonitorResponse> handler)

Description copied from interface: HealthChecksAsync

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.

Specified by:

createHttpMonitor in interface HealthChecksAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

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.

createOnDemandHttpProbe

public Future<CreateOnDemandHttpProbeResponse> createOnDemandHttpProbe(CreateOnDemandHttpProbeRequest request,
                                                                       AsyncHandler<CreateOnDemandHttpProbeRequest,CreateOnDemandHttpProbeResponse> handler)

Description copied from interface: HealthChecksAsync

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.

Specified by:

createOnDemandHttpProbe in interface HealthChecksAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

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.

createOnDemandPingProbe

public Future<CreateOnDemandPingProbeResponse> createOnDemandPingProbe(CreateOnDemandPingProbeRequest request,
                                                                       AsyncHandler<CreateOnDemandPingProbeRequest,CreateOnDemandPingProbeResponse> handler)

Description copied from interface: HealthChecksAsync

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.

Specified by:

createOnDemandPingProbe in interface HealthChecksAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

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.

createPingMonitor

public Future<CreatePingMonitorResponse> createPingMonitor(CreatePingMonitorRequest request,
                                                           AsyncHandler<CreatePingMonitorRequest,CreatePingMonitorResponse> handler)

Description copied from interface: HealthChecksAsync

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.

Specified by:

createPingMonitor in interface HealthChecksAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

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.

deleteHttpMonitor

public Future<DeleteHttpMonitorResponse> deleteHttpMonitor(DeleteHttpMonitorRequest request,
                                                           AsyncHandler<DeleteHttpMonitorRequest,DeleteHttpMonitorResponse> handler)

Description copied from interface: HealthChecksAsync

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

Specified by:

deleteHttpMonitor in interface HealthChecksAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

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.

deletePingMonitor

public Future<DeletePingMonitorResponse> deletePingMonitor(DeletePingMonitorRequest request,
                                                           AsyncHandler<DeletePingMonitorRequest,DeletePingMonitorResponse> handler)

Description copied from interface: HealthChecksAsync

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

Specified by:

deletePingMonitor in interface HealthChecksAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

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.

getHttpMonitor

public Future<GetHttpMonitorResponse> getHttpMonitor(GetHttpMonitorRequest request,
                                                     AsyncHandler<GetHttpMonitorRequest,GetHttpMonitorResponse> handler)

Description copied from interface: HealthChecksAsync

Gets the configuration for the specified monitor.

Specified by:

getHttpMonitor in interface HealthChecksAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

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.

getPingMonitor

public Future<GetPingMonitorResponse> getPingMonitor(GetPingMonitorRequest request,
                                                     AsyncHandler<GetPingMonitorRequest,GetPingMonitorResponse> handler)

Description copied from interface: HealthChecksAsync

Gets the configuration for the specified ping monitor.

Specified by:

getPingMonitor in interface HealthChecksAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

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.

listHealthChecksVantagePoints

public Future<ListHealthChecksVantagePointsResponse> listHealthChecksVantagePoints(ListHealthChecksVantagePointsRequest request,
                                                                                   AsyncHandler<ListHealthChecksVantagePointsRequest,ListHealthChecksVantagePointsResponse> handler)

Description copied from interface: HealthChecksAsync

Gets information about all vantage points available to the user.

Specified by:

listHealthChecksVantagePoints in interface HealthChecksAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

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.

listHttpMonitors

public Future<ListHttpMonitorsResponse> listHttpMonitors(ListHttpMonitorsRequest request,
                                                         AsyncHandler<ListHttpMonitorsRequest,ListHttpMonitorsResponse> handler)

Description copied from interface: HealthChecksAsync

Gets a list of HTTP monitors.

Specified by:

listHttpMonitors in interface HealthChecksAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

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.

listHttpProbeResults

public Future<ListHttpProbeResultsResponse> listHttpProbeResults(ListHttpProbeResultsRequest request,
                                                                 AsyncHandler<ListHttpProbeResultsRequest,ListHttpProbeResultsResponse> handler)

Description copied from interface: HealthChecksAsync

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.

Specified by:

listHttpProbeResults in interface HealthChecksAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

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.

listPingMonitors

public Future<ListPingMonitorsResponse> listPingMonitors(ListPingMonitorsRequest request,
                                                         AsyncHandler<ListPingMonitorsRequest,ListPingMonitorsResponse> handler)

Description copied from interface: HealthChecksAsync

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.

Specified by:

listPingMonitors in interface HealthChecksAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

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.

listPingProbeResults

public Future<ListPingProbeResultsResponse> listPingProbeResults(ListPingProbeResultsRequest request,
                                                                 AsyncHandler<ListPingProbeResultsRequest,ListPingProbeResultsResponse> handler)

Description copied from interface: HealthChecksAsync

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

Specified by:

listPingProbeResults in interface HealthChecksAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

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.

updateHttpMonitor

public Future<UpdateHttpMonitorResponse> updateHttpMonitor(UpdateHttpMonitorRequest request,
                                                           AsyncHandler<UpdateHttpMonitorRequest,UpdateHttpMonitorResponse> handler)

Description copied from interface: HealthChecksAsync

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.

Specified by:

updateHttpMonitor in interface HealthChecksAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

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.

updatePingMonitor

public Future<UpdatePingMonitorResponse> updatePingMonitor(UpdatePingMonitorRequest request,
                                                           AsyncHandler<UpdatePingMonitorRequest,UpdatePingMonitorResponse> handler)

Description copied from interface: HealthChecksAsync

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.

Specified by:

updatePingMonitor in interface HealthChecksAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

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.

getDefaultConfigurator

protected ClientConfigurator getDefaultConfigurator()

useRealmSpecificEndpointTemplate

public void useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)

This method should be used to enable or disable the use of realm-specific endpoint template. The default value is null. To enable the use of endpoint template defined for the realm in use, set the flag to true To disable the use of endpoint template defined for the realm in use, set the flag to false

Parameters:

useOfRealmSpecificEndpointTemplateEnabled - This flag can be set to true or false to enable or disable the use of realm-specific endpoint template respectively

populateServiceParametersInEndpoint

public final void populateServiceParametersInEndpoint(String endpoint,
                                                      Map<String,Object> requiredParametersMap)

Populate the parameters in the endpoint with its corresponding value and update the base endpoint. The value will be populated iff the parameter in endpoint is a required request path parameter or a required request query parameter. If not, the parameter in the endpoint will be ignored and left blank.

Parameters:

endpoint - The endpoint template in use

requiredParametersMap - Map of parameter name as key and value set in request path or query parameter as value

updateBaseEndpoint

public final void updateBaseEndpoint(String endpoint)

This method should be used for parameterized endpoint templates only. This does not include {region} and {secondLevelDomain} parameters.

Parameters:

endpoint - The updated endpoint to use

setEndpoint

public final void setEndpoint(String endpoint)

getEndpoint

public final String getEndpoint()

refreshClient

public final void refreshClient()

Rebuild the backing HttpClient. This will call ClientConfigurators again, and can be used to e.g. refresh the SSL certificate.

close

public final void close()

Specified by:

close in interface AutoCloseable

getClientCommonLibraryVersion

public String getClientCommonLibraryVersion()

getMinimumClientCommonLibraryVersionFromClient

public Optional<String> getMinimumClientCommonLibraryVersionFromClient()

clientCall

protected <REQ extends BmcRequest<?>,RESP extends BmcResponse,RESP_BUILDER extends BmcResponse.Builder<RESP>> ClientCall<REQ,RESP,RESP_BUILDER> clientCall(REQ request,
                                                                                                                                                           Supplier<RESP_BUILDER> responseBuilder)