@Generated(value="OracleSDKGenerator", comments="API Version: 20180501") public class HealthChecksClient extends Object implements HealthChecks
Modifier and Type | Class and Description |
---|---|
static class |
HealthChecksClient.Builder
Builder class for this client.
|
Modifier and Type | Field and Description |
---|---|
static Service |
SERVICE
Service instance for HealthChecks.
|
Modifier | Constructor and Description |
---|---|
|
HealthChecksClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory)
Creates a new service instance using the given authentication provider and client configuration.
|
|
HealthChecksClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
List<ClientConfigurator> additionalClientConfigurators)
Creates a new service instance using the given authentication provider and client configuration.
|
|
HealthChecksClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint)
Creates a new service instance using the given authentication provider and client configuration.
|
|
HealthChecksClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint)
Creates a new service instance using the given authentication provider and client configuration.
|
protected |
HealthChecksClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint,
RestClientFactoryBuilder restClientFactoryBuilder)
Creates a new service instance using the given authentication provider and client configuration.
|
|
HealthChecksClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Creates a new service instance using the given authentication provider.
|
|
HealthChecksClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration)
Creates a new service instance using the given authentication provider and client configuration.
|
|
HealthChecksClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator)
Creates a new service instance using the given authentication provider and client configuration.
|
Modifier and Type | Method and 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 |
getEndpoint()
Gets the set endpoint for REST call (ex, https://www.example.com)
|
GetHttpMonitorResponse |
getHttpMonitor(GetHttpMonitorRequest request)
Gets the configuration for the specified monitor.
|
HealthChecksPaginators |
getPaginators()
Gets the pre-configured paginators available for list operations in this service which may return multiple
pages of data.
|
GetPingMonitorResponse |
getPingMonitor(GetPingMonitorRequest request)
Gets the configuration for the specified ping monitor.
|
ListHealthChecksVantagePointsResponse |
listHealthChecksVantagePoints(ListHealthChecksVantagePointsRequest request)
Gets information about all vantage points available to the user.
|
ListHttpMonitorsResponse |
listHttpMonitors(ListHttpMonitorsRequest request)
Gets a list of HTTP monitors.
|
ListHttpProbeResultsResponse |
listHttpProbeResults(ListHttpProbeResultsRequest request)
Gets the HTTP probe results for the specified probe or monitor, where
the
probeConfigurationId is the OCID of either a monitor or an
on-demand probe. |
ListPingMonitorsResponse |
listPingMonitors(ListPingMonitorsRequest request)
Gets a list of configured ping monitors.
|
ListPingProbeResultsResponse |
listPingProbeResults(ListPingProbeResultsRequest request)
Returns the results for the specified probe, where the
probeConfigurationId
is the OCID of either a monitor or an on-demand probe. |
void |
setEndpoint(String endpoint)
Sets the endpoint to call (ex, https://www.example.com).
|
void |
setRegion(Region region)
Sets the region to call (ex, Region.US_PHOENIX_1).
|
void |
setRegion(String regionId)
Sets the region to call (ex, ‘us-phoenix-1’).
|
UpdateHttpMonitorResponse |
updateHttpMonitor(UpdateHttpMonitorRequest request)
Updates the configuration of the specified HTTP monitor.
|
UpdatePingMonitorResponse |
updatePingMonitor(UpdatePingMonitorRequest request)
Updates the configuration of the specified ping monitor.
|
public static final Service SERVICE
Service instance for HealthChecks.
public HealthChecksClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Creates a new service instance using the given authentication provider.
authenticationDetailsProvider
- The authentication details provider, required.public HealthChecksClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Creates a new service instance using the given authentication provider and client configuration.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.public HealthChecksClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.clientConfigurator
- ClientConfigurator that will be invoked for additional configuration of a REST client, optional.public HealthChecksClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
This is an advanced constructor for clients that want to take control over how requests are signed.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.clientConfigurator
- ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory
- The request signer factory used to create the request signer for this service.public HealthChecksClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
This is an advanced constructor for clients that want to take control over how requests are signed.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.clientConfigurator
- ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory
- The request signer factory used to create the request signer for this service.additionalClientConfigurators
- Additional client configurators to be run after the primary configurator.public HealthChecksClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
This is an advanced constructor for clients that want to take control over how requests are signed.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.clientConfigurator
- ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory
- The request signer factory used to create the request signer for this service.additionalClientConfigurators
- Additional client configurators to be run after the primary configurator.endpoint
- Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider
)public HealthChecksClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
This is an advanced constructor for clients that want to take control over how requests are signed.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.clientConfigurator
- ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory
- The request signer factory used to create the request signer for this service.signingStrategyRequestSignerFactories
- The request signer factories for each signing strategy used to create the request signeradditionalClientConfigurators
- Additional client configurators to be run after the primary configurator.endpoint
- Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider
)protected HealthChecksClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, RestClientFactoryBuilder restClientFactoryBuilder)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
This is an advanced constructor for clients that want to take control over how requests are signed.
Use the HealthChecksClient.Builder
to get access to all these parameters.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.clientConfigurator
- ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory
- The request signer factory used to create the request signer for this service.signingStrategyRequestSignerFactories
- The request signer factories for each signing strategy used to create the request signeradditionalClientConfigurators
- Additional client configurators to be run after the primary configurator.endpoint
- Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider
)restClientFactoryBuilder
- the builder for the RestClientFactory
public static HealthChecksClient.Builder builder()
Create a builder for this client.
public void setEndpoint(String endpoint)
HealthChecks
Sets the endpoint to call (ex, https://www.example.com).
setEndpoint
in interface HealthChecks
endpoint
- The endpoint of the service.public String getEndpoint()
HealthChecks
Gets the set endpoint for REST call (ex, https://www.example.com)
getEndpoint
in interface HealthChecks
public void setRegion(Region region)
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.
setRegion
in interface HealthChecks
region
- The region of the service.public void setRegion(String regionId)
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 call setEndpoint
.
setRegion
in interface HealthChecks
regionId
- The public region ID.public void close()
close
in interface AutoCloseable
public ChangeHttpMonitorCompartmentResponse changeHttpMonitorCompartment(ChangeHttpMonitorCompartmentRequest request)
HealthChecks
Moves a monitor into a different compartment. When provided, If-Match
is checked
against ETag values of the resource.
changeHttpMonitorCompartment
in interface HealthChecks
request
- The request object containing the details to sendpublic ChangePingMonitorCompartmentResponse changePingMonitorCompartment(ChangePingMonitorCompartmentRequest request)
HealthChecks
Moves a monitor into a different compartment. When provided, If-Match
is checked
against ETag values of the resource.
changePingMonitorCompartment
in interface HealthChecks
request
- The request object containing the details to sendpublic CreateHttpMonitorResponse createHttpMonitor(CreateHttpMonitorRequest request)
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
.
createHttpMonitor
in interface HealthChecks
request
- The request object containing the details to sendpublic CreateOnDemandHttpProbeResponse createOnDemandHttpProbe(CreateOnDemandHttpProbeRequest request)
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.
createOnDemandHttpProbe
in interface HealthChecks
request
- The request object containing the details to sendpublic CreateOnDemandPingProbeResponse createOnDemandPingProbe(CreateOnDemandPingProbeRequest request)
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.
createOnDemandPingProbe
in interface HealthChecks
request
- The request object containing the details to sendpublic CreatePingMonitorResponse createPingMonitor(CreatePingMonitorRequest request)
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
.
createPingMonitor
in interface HealthChecks
request
- The request object containing the details to sendpublic DeleteHttpMonitorResponse deleteHttpMonitor(DeleteHttpMonitorRequest request)
HealthChecks
Deletes the HTTP monitor and its configuration. All future probes of this monitor are stopped. Results associated with the monitor are not deleted.
deleteHttpMonitor
in interface HealthChecks
request
- The request object containing the details to sendpublic DeletePingMonitorResponse deletePingMonitor(DeletePingMonitorRequest request)
HealthChecks
Deletes the ping monitor and its configuration. All future probes of this monitor are stopped. Results associated with the monitor are not deleted.
deletePingMonitor
in interface HealthChecks
request
- The request object containing the details to sendpublic GetHttpMonitorResponse getHttpMonitor(GetHttpMonitorRequest request)
HealthChecks
Gets the configuration for the specified monitor.
getHttpMonitor
in interface HealthChecks
request
- The request object containing the details to sendpublic GetPingMonitorResponse getPingMonitor(GetPingMonitorRequest request)
HealthChecks
Gets the configuration for the specified ping monitor.
getPingMonitor
in interface HealthChecks
request
- The request object containing the details to sendpublic ListHealthChecksVantagePointsResponse listHealthChecksVantagePoints(ListHealthChecksVantagePointsRequest request)
HealthChecks
Gets information about all vantage points available to the user.
listHealthChecksVantagePoints
in interface HealthChecks
request
- The request object containing the details to sendpublic ListHttpMonitorsResponse listHttpMonitors(ListHttpMonitorsRequest request)
HealthChecks
Gets a list of HTTP monitors.
listHttpMonitors
in interface HealthChecks
request
- The request object containing the details to sendpublic ListHttpProbeResultsResponse listHttpProbeResults(ListHttpProbeResultsRequest request)
HealthChecks
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.
listHttpProbeResults
in interface HealthChecks
request
- The request object containing the details to sendpublic ListPingMonitorsResponse listPingMonitors(ListPingMonitorsRequest request)
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.
listPingMonitors
in interface HealthChecks
request
- The request object containing the details to sendpublic ListPingProbeResultsResponse listPingProbeResults(ListPingProbeResultsRequest request)
HealthChecks
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`.
listPingProbeResults
in interface HealthChecks
request
- The request object containing the details to sendpublic UpdateHttpMonitorResponse updateHttpMonitor(UpdateHttpMonitorRequest request)
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.
updateHttpMonitor
in interface HealthChecks
request
- The request object containing the details to sendpublic UpdatePingMonitorResponse updatePingMonitor(UpdatePingMonitorRequest request)
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.
updatePingMonitor
in interface HealthChecks
request
- The request object containing the details to sendpublic HealthChecksPaginators getPaginators()
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.
getPaginators
in interface HealthChecks
Copyright © 2016–2022. All rights reserved.