Class HealthChecksClient
Service client instance for HealthChecks.
Implements
Inherited Members
Namespace: Oci.HealthchecksService
Assembly: OCI.DotNetSDK.Healthchecks.dll
Syntax
public class HealthChecksClient : RegionalClientBase, IDisposable
Constructors
HealthChecksClient(IBasicAuthenticationDetailsProvider, ClientConfiguration, string)
Creates a new service instance using the given authentication provider and/or client configuration and/or endpoint. A client configuration can also be provided optionally to adjust REST client behaviors.
Declaration
public HealthChecksClient(IBasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration clientConfiguration = null, string endpoint = null)
Parameters
Type | Name | Description |
---|---|---|
IBasicAuthenticationDetailsProvider | authenticationDetailsProvider | The authentication details provider. Required. |
ClientConfiguration | clientConfiguration | The client configuration that contains settings to adjust REST client behaviors. Optional. |
string | endpoint | The endpoint of the service. If not provided and the client is a regional client, the endpoint will be constructed based on region information. Optional. |
Properties
Paginators
Declaration
public HealthChecksPaginators Paginators { get; }
Property Value
Type | Description |
---|---|
HealthChecksPaginators |
Methods
ChangeHttpMonitorCompartment(ChangeHttpMonitorCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Moves a monitor into a different compartment. When provided, If-Match
is checked
against ETag values of the resource.
Declaration
public Task<ChangeHttpMonitorCompartmentResponse> ChangeHttpMonitorCompartment(ChangeHttpMonitorCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ChangeHttpMonitorCompartmentRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ChangeHttpMonitorCompartmentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ChangeHttpMonitorCompartment API.
ChangePingMonitorCompartment(ChangePingMonitorCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Moves a monitor into a different compartment. When provided, If-Match
is checked
against ETag values of the resource.
Declaration
public Task<ChangePingMonitorCompartmentResponse> ChangePingMonitorCompartment(ChangePingMonitorCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ChangePingMonitorCompartmentRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ChangePingMonitorCompartmentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ChangePingMonitorCompartment API.
CreateHttpMonitor(CreateHttpMonitorRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
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
.
Declaration
public Task<CreateHttpMonitorResponse> CreateHttpMonitor(CreateHttpMonitorRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateHttpMonitorRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CreateHttpMonitorResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateHttpMonitor API.
CreateOnDemandHttpProbe(CreateOnDemandHttpProbeRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates an on-demand HTTP probe. The location response header contains the URL for fetching the probe results. <br/> Note: On-demand probe configurations are not saved.
Declaration
public Task<CreateOnDemandHttpProbeResponse> CreateOnDemandHttpProbe(CreateOnDemandHttpProbeRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateOnDemandHttpProbeRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CreateOnDemandHttpProbeResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateOnDemandHttpProbe API.
CreateOnDemandPingProbe(CreateOnDemandPingProbeRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates an on-demand ping probe. The location response header contains the URL for fetching probe results. <br/> Note: The on-demand probe configuration is not saved.
Declaration
public Task<CreateOnDemandPingProbeResponse> CreateOnDemandPingProbe(CreateOnDemandPingProbeRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateOnDemandPingProbeRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CreateOnDemandPingProbeResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateOnDemandPingProbe API.
CreatePingMonitor(CreatePingMonitorRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
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
.
Declaration
public Task<CreatePingMonitorResponse> CreatePingMonitor(CreatePingMonitorRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreatePingMonitorRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CreatePingMonitorResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreatePingMonitor API.
DeleteHttpMonitor(DeleteHttpMonitorRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deletes the HTTP monitor and its configuration. All future probes of this monitor are stopped. Results associated with the monitor are not deleted.
Declaration
public Task<DeleteHttpMonitorResponse> DeleteHttpMonitor(DeleteHttpMonitorRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteHttpMonitorRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DeleteHttpMonitorResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteHttpMonitor API.
DeletePingMonitor(DeletePingMonitorRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deletes the ping monitor and its configuration. All future probes of this monitor are stopped. Results associated with the monitor are not deleted.
Declaration
public Task<DeletePingMonitorResponse> DeletePingMonitor(DeletePingMonitorRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeletePingMonitorRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DeletePingMonitorResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeletePingMonitor API.
GetHttpMonitor(GetHttpMonitorRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets the configuration for the specified monitor.
Declaration
public Task<GetHttpMonitorResponse> GetHttpMonitor(GetHttpMonitorRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetHttpMonitorRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetHttpMonitorResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetHttpMonitor API.
GetPingMonitor(GetPingMonitorRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets the configuration for the specified ping monitor.
Declaration
public Task<GetPingMonitorResponse> GetPingMonitor(GetPingMonitorRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetPingMonitorRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetPingMonitorResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetPingMonitor API.
ListHealthChecksVantagePoints(ListHealthChecksVantagePointsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets information about all vantage points available to the user.
Declaration
public Task<ListHealthChecksVantagePointsResponse> ListHealthChecksVantagePoints(ListHealthChecksVantagePointsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListHealthChecksVantagePointsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListHealthChecksVantagePointsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListHealthChecksVantagePoints API.
ListHttpMonitors(ListHttpMonitorsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets a list of HTTP monitors.
Declaration
public Task<ListHttpMonitorsResponse> ListHttpMonitors(ListHttpMonitorsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListHttpMonitorsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListHttpMonitorsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListHttpMonitors API.
ListHttpProbeResults(ListHttpProbeResultsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
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.
Declaration
public Task<ListHttpProbeResultsResponse> ListHttpProbeResults(ListHttpProbeResultsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListHttpProbeResultsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListHttpProbeResultsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListHttpProbeResults API.
ListPingMonitors(ListPingMonitorsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets a list of configured ping monitors.
<br/>
Results are paginated based on page
and limit
. The opc-next-page
header provides
a URL for fetching the next page.
Declaration
public Task<ListPingMonitorsResponse> ListPingMonitors(ListPingMonitorsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListPingMonitorsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListPingMonitorsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListPingMonitors API.
ListPingProbeResults(ListPingProbeResultsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns the results for the specified probe, where the probeConfigurationId
is the OCID of either a monitor or an on-demand probe.
<br/>
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
.
Declaration
public Task<ListPingProbeResultsResponse> ListPingProbeResults(ListPingProbeResultsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListPingProbeResultsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListPingProbeResultsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListPingProbeResults API.
UpdateHttpMonitor(UpdateHttpMonitorRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
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.
Declaration
public Task<UpdateHttpMonitorResponse> UpdateHttpMonitor(UpdateHttpMonitorRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateHttpMonitorRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdateHttpMonitorResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateHttpMonitor API.
UpdatePingMonitor(UpdatePingMonitorRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
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.
Declaration
public Task<UpdatePingMonitorResponse> UpdatePingMonitor(UpdatePingMonitorRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdatePingMonitorRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdatePingMonitorResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdatePingMonitor API.