Interface IRoutesService
Represents a collection of functions to interact with the API endpoints
Namespace: InfluxDB.Client.Api.Service
Assembly: InfluxDB.Client.dll
Syntax
public interface IRoutesService : IApiAccessorMethods
GetRoutes(String)
List all top level routes
Declaration
Routes GetRoutes(string zapTraceSpan = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | zapTraceSpan | OpenTracing span context (optional) |
Returns
| Type | Description |
|---|---|
| Routes | Routes |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetRoutesAsync(String, CancellationToken)
List all top level routes
Declaration
System.Threading.Tasks.Task<Routes> GetRoutesAsync(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<Routes> | Task of Routes |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetRoutesAsyncWithHttpInfo(String, CancellationToken)
List all top level routes
Declaration
System.Threading.Tasks.Task<ApiResponse<Routes>> GetRoutesAsyncWithHttpInfo(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<Routes>> | Task of ApiResponse (Routes) |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetRoutesWithHttpInfo(String)
List all top level routes
Declaration
ApiResponse<Routes> GetRoutesWithHttpInfo(string zapTraceSpan = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | zapTraceSpan | OpenTracing span context (optional) |
Returns
| Type | Description |
|---|---|
| InfluxDB.Client.Api.Client.ApiResponse<Routes> | ApiResponse of Routes |
Exceptions
| Type | Condition |
|---|---|
| InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |