Class HealthChecksClient
- java.lang.Object
-
- com.oracle.bmc.http.internal.BaseSyncClient
-
- com.oracle.bmc.healthchecks.HealthChecksClient
-
- All Implemented Interfaces:
HealthChecks
,AutoCloseable
@Generated(value="OracleSDKGenerator", comments="API Version: 20180501") public class HealthChecksClient extends BaseSyncClient implements HealthChecks
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
HealthChecksClient.Builder
Builder class for this client.
-
Field Summary
Fields Modifier and Type Field 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 Description HealthChecksClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Deprecated.Use thebuilder
instead.HealthChecksClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
Deprecated.Use thebuilder
instead.HealthChecksClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilder
instead.HealthChecksClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilder
instead.HealthChecksClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.Use thebuilder
instead.HealthChecksClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Deprecated.Use thebuilder
instead.HealthChecksClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Deprecated.Use thebuilder
instead.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static HealthChecksClient.Builder
builder()
Create a builder for this client.ChangeHttpMonitorCompartmentResponse
changeHttpMonitorCompartment(ChangeHttpMonitorCompartmentRequest request)
Moves a monitor into a different compartment.ChangePingMonitorCompartmentResponse
changePingMonitorCompartment(ChangePingMonitorCompartmentRequest request)
Moves a monitor into a different compartment.void
close()
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.String
getClientCommonLibraryVersion()
protected ClientConfigurator
getDefaultConfigurator()
String
getEndpoint()
GetHttpMonitorResponse
getHttpMonitor(GetHttpMonitorRequest request)
Gets the configuration for the specified monitor.Optional<String>
getMinimumClientCommonLibraryVersionFromClient()
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 theprobeConfigurationId
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 theprobeConfigurationId
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 backingHttpClient
.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.UpdateHttpMonitorResponse
updateHttpMonitor(UpdateHttpMonitorRequest request)
Updates the configuration of the specified HTTP monitor.UpdatePingMonitorResponse
updatePingMonitor(UpdatePingMonitorRequest request)
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 com.oracle.bmc.http.internal.BaseSyncClient
clientCall
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface java.lang.AutoCloseable
close
-
Methods inherited from interface com.oracle.bmc.healthchecks.HealthChecks
getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate
-
-
-
-
Constructor Detail
-
HealthChecksClient
@Deprecated public HealthChecksClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeHealthChecksClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)
-
HealthChecksClient
@Deprecated public HealthChecksClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeHealthChecksClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
-
HealthChecksClient
@Deprecated public HealthChecksClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeHealthChecksClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
clientConfigurator
-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
-
HealthChecksClient
@Deprecated public HealthChecksClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeHealthChecksClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
clientConfigurator
-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
-ClientBuilderBase.requestSignerFactory
-
HealthChecksClient
@Deprecated public HealthChecksClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeHealthChecksClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
clientConfigurator
-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
-ClientBuilderBase.requestSignerFactory
additionalClientConfigurators
-ClientBuilderBase.additionalClientConfigurators
-
HealthChecksClient
@Deprecated public HealthChecksClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeHealthChecksClient.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)
-
HealthChecksClient
@Deprecated public HealthChecksClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeHealthChecksClient.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 HealthChecksClient.Builder builder()
Create a builder for this client.- Returns:
- builder
-
setRegion
public void setRegion(Region region)
Description copied from interface:HealthChecks
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 interfaceHealthChecks
- Parameters:
region
- The region of the service.
-
setRegion
public void setRegion(String regionId)
Description copied from interface:HealthChecks
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 callsetEndpoint
.- Specified by:
setRegion
in interfaceHealthChecks
- Parameters:
regionId
- The public region ID.
-
changeHttpMonitorCompartment
public ChangeHttpMonitorCompartmentResponse changeHttpMonitorCompartment(ChangeHttpMonitorCompartmentRequest request)
Description copied from interface:HealthChecks
Moves a monitor into a different compartment.When provided,
If-Match
is checked against ETag values of the resource.- Specified by:
changeHttpMonitorCompartment
in interfaceHealthChecks
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
changePingMonitorCompartment
public ChangePingMonitorCompartmentResponse changePingMonitorCompartment(ChangePingMonitorCompartmentRequest request)
Description copied from interface:HealthChecks
Moves a monitor into a different compartment.When provided,
If-Match
is checked against ETag values of the resource.- Specified by:
changePingMonitorCompartment
in interfaceHealthChecks
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createHttpMonitor
public CreateHttpMonitorResponse createHttpMonitor(CreateHttpMonitorRequest request)
Description copied from interface:HealthChecks
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 interfaceHealthChecks
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createOnDemandHttpProbe
public CreateOnDemandHttpProbeResponse createOnDemandHttpProbe(CreateOnDemandHttpProbeRequest request)
Description copied from interface:HealthChecks
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 interfaceHealthChecks
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createOnDemandPingProbe
public CreateOnDemandPingProbeResponse createOnDemandPingProbe(CreateOnDemandPingProbeRequest request)
Description copied from interface:HealthChecks
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 interfaceHealthChecks
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createPingMonitor
public CreatePingMonitorResponse createPingMonitor(CreatePingMonitorRequest request)
Description copied from interface:HealthChecks
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 interfaceHealthChecks
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteHttpMonitor
public DeleteHttpMonitorResponse deleteHttpMonitor(DeleteHttpMonitorRequest request)
Description copied from interface:HealthChecks
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 interfaceHealthChecks
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deletePingMonitor
public DeletePingMonitorResponse deletePingMonitor(DeletePingMonitorRequest request)
Description copied from interface:HealthChecks
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 interfaceHealthChecks
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getHttpMonitor
public GetHttpMonitorResponse getHttpMonitor(GetHttpMonitorRequest request)
Description copied from interface:HealthChecks
Gets the configuration for the specified monitor.- Specified by:
getHttpMonitor
in interfaceHealthChecks
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getPingMonitor
public GetPingMonitorResponse getPingMonitor(GetPingMonitorRequest request)
Description copied from interface:HealthChecks
Gets the configuration for the specified ping monitor.- Specified by:
getPingMonitor
in interfaceHealthChecks
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listHealthChecksVantagePoints
public ListHealthChecksVantagePointsResponse listHealthChecksVantagePoints(ListHealthChecksVantagePointsRequest request)
Description copied from interface:HealthChecks
Gets information about all vantage points available to the user.- Specified by:
listHealthChecksVantagePoints
in interfaceHealthChecks
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listHttpMonitors
public ListHttpMonitorsResponse listHttpMonitors(ListHttpMonitorsRequest request)
Description copied from interface:HealthChecks
Gets a list of HTTP monitors.- Specified by:
listHttpMonitors
in interfaceHealthChecks
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listHttpProbeResults
public ListHttpProbeResultsResponse listHttpProbeResults(ListHttpProbeResultsRequest request)
Description copied from interface:HealthChecks
Gets the HTTP probe results for the specified probe or monitor, where theprobeConfigurationId
is the OCID of either a monitor or an on-demand probe.- Specified by:
listHttpProbeResults
in interfaceHealthChecks
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listPingMonitors
public ListPingMonitorsResponse listPingMonitors(ListPingMonitorsRequest request)
Description copied from interface:HealthChecks
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 interfaceHealthChecks
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listPingProbeResults
public ListPingProbeResultsResponse listPingProbeResults(ListPingProbeResultsRequest request)
Description copied from interface:HealthChecks
Returns the results for the specified probe, where theprobeConfigurationId
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 interfaceHealthChecks
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateHttpMonitor
public UpdateHttpMonitorResponse updateHttpMonitor(UpdateHttpMonitorRequest request)
Description copied from interface:HealthChecks
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 interfaceHealthChecks
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updatePingMonitor
public UpdatePingMonitorResponse updatePingMonitor(UpdatePingMonitorRequest request)
Description copied from interface:HealthChecks
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 interfaceHealthChecks
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getPaginators
public HealthChecksPaginators getPaginators()
Description copied from interface:HealthChecks
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.- Specified by:
getPaginators
in interfaceHealthChecks
- Returns:
- The service paginators.
-
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 userequiredParametersMap
- 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 backingHttpClient
.This will call
ClientConfigurator
s again, and can be used to e.g. refresh the SSL certificate.
-
close
public final void close()
- Specified by:
close
in interfaceAutoCloseable
-
getClientCommonLibraryVersion
public String getClientCommonLibraryVersion()
-
-