Interface IReadyService

Represents a collection of functions to interact with the API endpoints

Namespace: InfluxDB.Client.Api.Service

Assembly: InfluxDB.Client.dll

Syntax

public interface IReadyService : IApiAccessor

Methods

GetReady(String)

Get the readiness of an instance at startup

Declaration

Ready GetReady(string zapTraceSpan = null)

Parameters

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

Returns

Type	Description
Ready	Ready

Exceptions

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

GetReadyAsync(String, CancellationToken)

Get the readiness of an instance at startup

Declaration

System.Threading.Tasks.Task<Ready> GetReadyAsync(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<Ready>	Task of Ready

Exceptions

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

GetReadyAsyncWithHttpInfo(String, CancellationToken)

Get the readiness of an instance at startup

Declaration

System.Threading.Tasks.Task<ApiResponse<Ready>> GetReadyAsyncWithHttpInfo(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<Ready>>	Task of ApiResponse (Ready)

Exceptions

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

GetReadyWithHttpInfo(String)

Get the readiness of an instance at startup

Declaration

ApiResponse<Ready> GetReadyWithHttpInfo(string zapTraceSpan = null)

Parameters

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

Returns

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

Exceptions

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