Interface IHealthService

Represents a collection of functions to interact with the API endpoints

Namespace: InfluxDB.Client.Api.Service

Assembly: InfluxDB.Client.dll

Syntax

public interface IHealthService : IApiAccessor

Methods

GetHealth(String)

Get the health of an instance

Declaration

HealthCheck GetHealth(string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	zapTraceSpan	OpenTracing span context (optional)

Returns

Type	Description
HealthCheck	HealthCheck

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

GetHealthAsync(String, CancellationToken)

Get the health of an instance

Declaration

System.Threading.Tasks.Task<HealthCheck> GetHealthAsync(string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	zapTraceSpan	OpenTracing span context (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<HealthCheck>	Task of HealthCheck

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

GetHealthAsyncWithHttpInfo(String, CancellationToken)

Get the health of an instance

Declaration

System.Threading.Tasks.Task<ApiResponse<HealthCheck>> GetHealthAsyncWithHttpInfo(string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	zapTraceSpan	OpenTracing span context (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<HealthCheck>>	Task of ApiResponse (HealthCheck)

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

GetHealthWithHttpInfo(String)

Get the health of an instance

Declaration

ApiResponse<HealthCheck> GetHealthWithHttpInfo(string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	zapTraceSpan	OpenTracing span context (optional)

Returns

Type	Description
InfluxDB.Client.Api.Client.ApiResponse<HealthCheck>	ApiResponse of HealthCheck

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call