Interface ITelegrafPluginsService

Represents a collection of functions to interact with the API endpoints

Namespace: InfluxDB.Client.Api.Service

Assembly: InfluxDB.Client.dll

Syntax

public interface ITelegrafPluginsService : IApiAccessor

Methods

GetTelegrafPlugins(String, String)

List all Telegraf plugins

Declaration

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

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

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

GetTelegrafPluginsWithHttpInfo(String, String)

List all Telegraf plugins

Declaration

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