Class PingService

Represents a collection of functions to interact with the API endpoints

Inheritance

System.Object

PingService

Implements

IPingService

Namespace: InfluxDB.Client.Api.Service

Assembly: InfluxDB.Client.dll

Syntax

public class PingService : object, IPingService, IApiAccessor

Constructors

PingService(Configuration)

Initializes a new instance of the PingService class using Configuration object

Declaration

public PingService(Configuration configuration = null)

Parameters

Type	Name	Description
InfluxDB.Client.Api.Client.Configuration	configuration	An instance of Configuration

PingService(String)

Initializes a new instance of the PingService class.

Declaration

public PingService(string basePath)

Parameters

Type	Name	Description
System.String	basePath

Properties

Configuration

Gets or sets the configuration object

Declaration

public Configuration Configuration { get; set; }

Property Value

Type	Description
InfluxDB.Client.Api.Client.Configuration	An instance of the Configuration

ExceptionFactory

Provides a factory method hook for the creation of exceptions.

Declaration

public ExceptionFactory ExceptionFactory { get; set; }

Property Value

Type	Description
InfluxDB.Client.Api.Client.ExceptionFactory

Methods

AddDefaultHeader(String, String)

Add default header.

Declaration

public void AddDefaultHeader(string key, string value)

Parameters

Type	Name	Description
System.String	key	Header field name.
System.String	value	Header field value.

DefaultHeader()

Gets the default header.

Declaration

public IDictionary<string, string> DefaultHeader()

Returns

Type	Description
IDictionary<System.String, System.String>	Dictionary of HTTP header

GetBasePath()

Gets the base path of the API client.

Declaration

public string GetBasePath()

Returns

Type	Description
System.String	The base path

GetPing()

Checks the status of InfluxDB instance and version of InfluxDB.

Declaration

public 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

public 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

public 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

GetPingAsyncWithIRestResponse(CancellationToken)

Checks the status of InfluxDB instance and version of InfluxDB.

Declaration

public System.Threading.Tasks.Task<RestResponse> GetPingAsyncWithIRestResponse(CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
CancellationToken	cancellationToken	Cancellation token

Returns

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

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

public 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

GetPingWithIRestResponse()

Checks the status of InfluxDB instance and version of InfluxDB.

Declaration

public RestResponse GetPingWithIRestResponse()

Returns

Type	Description
RestResponse	ApiResponse of Object(void)

Exceptions

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

GetPingWithIRestResponseAsync(CancellationToken)

Checks the status of InfluxDB instance and version of InfluxDB.

Declaration

public System.Threading.Tasks.Task<RestResponse> GetPingWithIRestResponseAsync(CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<RestResponse>	ApiResponse of Object(void)

Exceptions

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

GetPingWithRestRequest()

Checks the status of InfluxDB instance and version of InfluxDB.

Declaration

public RestRequest GetPingWithRestRequest()

Returns

Type	Description
RestRequest	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

public 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

public 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

public 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

HeadPingAsyncWithIRestResponse(CancellationToken)

Checks the status of InfluxDB instance and version of InfluxDB.

Declaration

public System.Threading.Tasks.Task<RestResponse> HeadPingAsyncWithIRestResponse(CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
CancellationToken	cancellationToken	Cancellation token

Returns

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

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

public 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

HeadPingWithIRestResponse()

Checks the status of InfluxDB instance and version of InfluxDB.

Declaration

public RestResponse HeadPingWithIRestResponse()

Returns

Type	Description
RestResponse	ApiResponse of Object(void)

Exceptions

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

HeadPingWithIRestResponseAsync(CancellationToken)

Checks the status of InfluxDB instance and version of InfluxDB.

Declaration

public System.Threading.Tasks.Task<RestResponse> HeadPingWithIRestResponseAsync(CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<RestResponse>	ApiResponse of Object(void)

Exceptions

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

HeadPingWithRestRequest()

Checks the status of InfluxDB instance and version of InfluxDB.

Declaration

public RestRequest HeadPingWithRestRequest()

Returns

Type	Description
RestRequest	ApiResponse of Object(void)

Exceptions

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

SetBasePath(String)

Sets the base path of the API client.

Declaration

public void SetBasePath(string basePath)

Parameters

Type	Name	Description
System.String	basePath

Implements

IPingService