Class TelegrafPluginsService

Represents a collection of functions to interact with the API endpoints

Inheritance

System.Object

TelegrafPluginsService

Implements

ITelegrafPluginsService

Namespace: InfluxDB.Client.Api.Service

Assembly: InfluxDB.Client.dll

Syntax

public class TelegrafPluginsService : object, ITelegrafPluginsService, IApiAccessor

Constructors

TelegrafPluginsService(Configuration)

Initializes a new instance of the TelegrafPluginsService class using Configuration object

Declaration

public TelegrafPluginsService(Configuration configuration = null)

Parameters

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

TelegrafPluginsService(String)

Initializes a new instance of the TelegrafPluginsService class.

Declaration

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

GetTelegrafPlugins(String, String)

List all Telegraf plugins

Declaration

public TelegrafPlugins GetTelegrafPlugins(string zapTraceSpan = null, string type = null)

Parameters

Type	Name	Description
System.String	zapTraceSpan	OpenTracing span context (optional)
System.String	type	The type of plugin desired. (optional)

Returns

Type	Description
TelegrafPlugins	TelegrafPlugins

Exceptions

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

GetTelegrafPluginsAsync(String, String, CancellationToken)

List all Telegraf plugins

Declaration

public async System.Threading.Tasks.Task<TelegrafPlugins> GetTelegrafPluginsAsync(string zapTraceSpan = null, string type = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	zapTraceSpan	OpenTracing span context (optional)
System.String	type	The type of plugin desired. (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

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

Exceptions

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

GetTelegrafPluginsAsyncWithHttpInfo(String, String, CancellationToken)

List all Telegraf plugins

Declaration

public async System.Threading.Tasks.Task<ApiResponse<TelegrafPlugins>> GetTelegrafPluginsAsyncWithHttpInfo(string zapTraceSpan = null, string type = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	zapTraceSpan	OpenTracing span context (optional)
System.String	type	The type of plugin desired. (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<TelegrafPlugins>>	Task of ApiResponse (TelegrafPlugins)

Exceptions

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

GetTelegrafPluginsAsyncWithIRestResponse(String, String, CancellationToken)

List all Telegraf plugins

Declaration

public async System.Threading.Tasks.Task<RestResponse> GetTelegrafPluginsAsyncWithIRestResponse(string zapTraceSpan = null, string type = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	zapTraceSpan	OpenTracing span context (optional)
System.String	type	The type of plugin desired. (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<RestResponse>	Task of RestResponse (TelegrafPlugins)

Exceptions

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

GetTelegrafPluginsWithHttpInfo(String, String)

List all Telegraf plugins

Declaration

public ApiResponse<TelegrafPlugins> GetTelegrafPluginsWithHttpInfo(string zapTraceSpan = null, string type = null)

Parameters

Type	Name	Description
System.String	zapTraceSpan	OpenTracing span context (optional)
System.String	type	The type of plugin desired. (optional)

Returns

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

Exceptions

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

GetTelegrafPluginsWithIRestResponse(String, String)

List all Telegraf plugins

Declaration

public RestResponse GetTelegrafPluginsWithIRestResponse(string zapTraceSpan = null, string type = null)

Parameters

Type	Name	Description
System.String	zapTraceSpan	OpenTracing span context (optional)
System.String	type	The type of plugin desired. (optional)

Returns

Type	Description
RestResponse	ApiResponse of TelegrafPlugins

Exceptions

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

GetTelegrafPluginsWithIRestResponseAsync(String, String, CancellationToken)

List all Telegraf plugins

Declaration

public async System.Threading.Tasks.Task<RestResponse> GetTelegrafPluginsWithIRestResponseAsync(string zapTraceSpan = null, string type = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	zapTraceSpan	OpenTracing span context (optional)
System.String	type	The type of plugin desired. (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

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

Exceptions

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

GetTelegrafPluginsWithRestRequest(String, String)

List all Telegraf plugins

Declaration

public RestRequest GetTelegrafPluginsWithRestRequest(string zapTraceSpan = null, string type = null)

Parameters

Type	Name	Description
System.String	zapTraceSpan	OpenTracing span context (optional)
System.String	type	The type of plugin desired. (optional)

Returns

Type	Description
RestRequest	ApiResponse of TelegrafPlugins

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

ITelegrafPluginsService