Interface IPingService
Represents a collection of functions to interact with the API endpoints
Namespace: InfluxDB.Client.Api.Service
Assembly: InfluxDB.Client.dll
Syntax
public interface IPingService : IApiAccessorMethods
GetPing()
Checks the status of InfluxDB instance and version of InfluxDB.
Declaration
void GetPing()Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetPingAsync(CancellationToken)
Checks the status of InfluxDB instance and version of InfluxDB.
Declaration
System.Threading.Tasks.Task GetPingAsync(CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| CancellationToken | cancellationToken | Cancellation token |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task | Task of void |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetPingAsyncWithHttpInfo(CancellationToken)
Checks the status of InfluxDB instance and version of InfluxDB.
Declaration
System.Threading.Tasks.Task<ApiResponse<object>> GetPingAsyncWithHttpInfo(CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| CancellationToken | cancellationToken | Cancellation token |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<System.Object>> | Task of ApiResponse |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetPingWithHttpInfo()
Checks the status of InfluxDB instance and version of InfluxDB.
Declaration
ApiResponse<object> GetPingWithHttpInfo()Returns
| Type | Description |
|---|---|
| InfluxDB.Client.Api.Client.ApiResponse<System.Object> | ApiResponse of Object(void) |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
HeadPing()
Checks the status of InfluxDB instance and version of InfluxDB.
Declaration
void HeadPing()Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
HeadPingAsync(CancellationToken)
Checks the status of InfluxDB instance and version of InfluxDB.
Declaration
System.Threading.Tasks.Task HeadPingAsync(CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| CancellationToken | cancellationToken | Cancellation token |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task | Task of void |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
HeadPingAsyncWithHttpInfo(CancellationToken)
Checks the status of InfluxDB instance and version of InfluxDB.
Declaration
System.Threading.Tasks.Task<ApiResponse<object>> HeadPingAsyncWithHttpInfo(CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| CancellationToken | cancellationToken | Cancellation token |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<System.Object>> | Task of ApiResponse |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
HeadPingWithHttpInfo()
Checks the status of InfluxDB instance and version of InfluxDB.
Declaration
ApiResponse<object> HeadPingWithHttpInfo()Returns
| Type | Description |
|---|---|
| InfluxDB.Client.Api.Client.ApiResponse<System.Object> | ApiResponse of Object(void) |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |