Class RoutesService

Represents a collection of functions to interact with the API endpoints

Inheritance

System.Object

RoutesService

Implements

IRoutesService

Namespace: InfluxDB.Client.Api.Service

Assembly: InfluxDB.Client.dll

Syntax

public class RoutesService : object, IRoutesService, IApiAccessor

Constructors

RoutesService(Configuration)

Initializes a new instance of the RoutesService class using Configuration object

Declaration

public RoutesService(Configuration configuration = null)

Parameters

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

RoutesService(String)

Initializes a new instance of the RoutesService class.

Declaration

public RoutesService(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

GetRoutes(String)

List all top level routes

Declaration

public 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

public async 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

public async 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

GetRoutesAsyncWithIRestResponse(String, CancellationToken)

List all top level routes

Declaration

public async System.Threading.Tasks.Task<RestResponse> GetRoutesAsyncWithIRestResponse(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<RestResponse>	Task of RestResponse (Routes)

Exceptions

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

GetRoutesWithHttpInfo(String)

List all top level routes

Declaration

public 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

GetRoutesWithIRestResponse(String)

List all top level routes

Declaration

public RestResponse GetRoutesWithIRestResponse(string zapTraceSpan = null)

Parameters

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

Returns

Type	Description
RestResponse	ApiResponse of Routes

Exceptions

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

GetRoutesWithIRestResponseAsync(String, CancellationToken)

List all top level routes

Declaration

public async System.Threading.Tasks.Task<RestResponse> GetRoutesWithIRestResponseAsync(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<RestResponse>	ApiResponse of Routes

Exceptions

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

GetRoutesWithRestRequest(String)

List all top level routes

Declaration

public RestRequest GetRoutesWithRestRequest(string zapTraceSpan = null)

Parameters

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

Returns

Type	Description
RestRequest	ApiResponse of Routes

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

IRoutesService