Class TelegrafsApi

The client of the InfluxDB 2.x that implement Telegrafs HTTP API endpoint.

Inheritance

System.Object

TelegrafsApi

Implements

ITelegrafsApi

Namespace: InfluxDB.Client

Assembly: InfluxDB.Client.dll

Syntax

public class TelegrafsApi : object, ITelegrafsApi

Constructors

TelegrafsApi(TelegrafsService)

Declaration

protected TelegrafsApi(TelegrafsService service)

Parameters

Type	Name	Description
TelegrafsService	service

Methods

AddLabelAsync(Label, Telegraf, CancellationToken)

Add a label to a telegraf config.

Declaration

public Task<Label> AddLabelAsync(Label label, Telegraf telegraf, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
Label	label	label to add
Telegraf	telegraf	the telegraf config
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
Task<Label>	added label

AddLabelAsync(String, String, CancellationToken)

Add a label to a telegraf config.

Declaration

public async Task<Label> AddLabelAsync(string labelId, string telegrafId, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	labelId	ID of label to add
System.String	telegrafId	ID of the telegraf config
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
Task<Label>	added label

AddMemberAsync(User, Telegraf, CancellationToken)

Add telegraf config member.

Declaration

public Task<ResourceMember> AddMemberAsync(User member, Telegraf telegraf, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
User	member	user to add as member
Telegraf	telegraf	the telegraf config
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
Task<ResourceMember>	member added to telegraf

AddMemberAsync(String, String, CancellationToken)

Add telegraf config member.

Declaration

public Task<ResourceMember> AddMemberAsync(string memberId, string telegrafId, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	memberId	user ID to add as member
System.String	telegrafId	ID of the telegraf config
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
Task<ResourceMember>	member added to telegraf

AddOwnerAsync(User, Telegraf, CancellationToken)

Add telegraf config owner.

Declaration

public Task<ResourceOwner> AddOwnerAsync(User owner, Telegraf telegraf, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
User	owner	user to add as owner
Telegraf	telegraf	the telegraf config
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
Task<ResourceOwner>	telegraf config owner added

AddOwnerAsync(String, String, CancellationToken)

Add telegraf config owner.

Declaration

public Task<ResourceOwner> AddOwnerAsync(string ownerId, string telegrafId, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	ownerId	ID of user to add as owner
System.String	telegrafId	ID of the telegraf config
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
Task<ResourceOwner>	telegraf config owner added

CloneTelegrafAsync(String, Telegraf, CancellationToken)

Clone a telegraf config.

Declaration

public async Task<Telegraf> CloneTelegrafAsync(string clonedName, Telegraf telegraf, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	clonedName	name of cloned telegraf config
Telegraf	telegraf	telegraf config to clone>
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
Task<Telegraf>	cloned telegraf config

CloneTelegrafAsync(String, String, CancellationToken)

Clone a telegraf config.

Declaration

public async Task<Telegraf> CloneTelegrafAsync(string clonedName, string telegrafId, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	clonedName	name of cloned telegraf config
System.String	telegrafId	ID of telegraf config to clone
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
Task<Telegraf>	cloned telegraf config

CreateAgentConfiguration()

Created default Telegraf Agent configuration. [agent] interval = "10s" round_interval = true metric_batch_size = 1000 metric_buffer_limit = 10000 collection_jitter = "0s" flush_jitter = "0s" precision = "" omit_hostname = false

Declaration

public Dictionary<string, object> CreateAgentConfiguration()

Returns

Type	Description
Dictionary<System.String, System.Object>	default configuration

CreateTelegrafAsync(TelegrafPluginRequest, CancellationToken)

Create a telegraf config.

Declaration

public Task<Telegraf> CreateTelegrafAsync(TelegrafPluginRequest telegrafRequest, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
TelegrafPluginRequest	telegrafRequest	Telegraf Configuration to create
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
Task<Telegraf>	Telegraf config created

CreateTelegrafAsync(String, String, Organization, Dictionary<String, Object>, List<TelegrafPlugin>, CancellationToken)

Create a telegraf config.

Declaration

public Task<Telegraf> CreateTelegrafAsync(string name, string description, Organization org, Dictionary<string, object> agentConfiguration, List<TelegrafPlugin> plugins, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	name	Telegraf Configuration Name
System.String	description	Telegraf Configuration Description
Organization	org	The organization that owns this config
Dictionary<System.String, System.Object>	agentConfiguration	The telegraf agent config
List<TelegrafPlugin>	plugins	The telegraf plugins config
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
Task<Telegraf>	Telegraf config created

CreateTelegrafAsync(String, String, Organization, List<TelegrafPlugin>, CancellationToken)

Create a telegraf config.

Declaration

public Task<Telegraf> CreateTelegrafAsync(string name, string description, Organization org, List<TelegrafPlugin> plugins, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	name	Telegraf Configuration Name
System.String	description	Telegraf Configuration Description
Organization	org	The organization that owns this config
List<TelegrafPlugin>	plugins	The telegraf plugins config
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
Task<Telegraf>	Telegraf config created

CreateTelegrafAsync(String, String, Organization, String, TelegrafRequestMetadata, List<TelegrafPluginRequestPlugins>, CancellationToken)

Create a telegraf config.

Declaration

public Task<Telegraf> CreateTelegrafAsync(string name, string description, Organization org, string config, TelegrafRequestMetadata metadata, List<TelegrafPluginRequestPlugins> plugins = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	name	Telegraf Configuration Name
System.String	description	Telegraf Configuration Description
Organization	org	The organization that owns this config
System.String	config	ConfigTOML contains the raw toml config
TelegrafRequestMetadata	metadata	Metadata for the config
List<TelegrafPluginRequestPlugins>	plugins	Plugins to use.
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
Task<Telegraf>	Telegraf config created

CreateTelegrafAsync(String, String, String, Dictionary<String, Object>, List<TelegrafPlugin>, CancellationToken)

Create a telegraf config.

Declaration

public Task<Telegraf> CreateTelegrafAsync(string name, string description, string orgId, Dictionary<string, object> agentConfiguration, List<TelegrafPlugin> plugins, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	name	Telegraf Configuration Name
System.String	description	Telegraf Configuration Description
System.String	orgId	The organization that owns this config
Dictionary<System.String, System.Object>	agentConfiguration	The telegraf agent config
List<TelegrafPlugin>	plugins	The telegraf plugins config
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
Task<Telegraf>	Telegraf config created

CreateTelegrafAsync(String, String, String, List<TelegrafPlugin>, CancellationToken)

Create a telegraf config.

Declaration

public Task<Telegraf> CreateTelegrafAsync(string name, string description, string orgId, List<TelegrafPlugin> plugins, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	name	Telegraf Configuration Name
System.String	description	Telegraf Configuration Description
System.String	orgId	The organization that owns this config
List<TelegrafPlugin>	plugins	The telegraf plugins config
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
Task<Telegraf>	Telegraf config created

CreateTelegrafAsync(String, String, String, String, TelegrafRequestMetadata, List<TelegrafPluginRequestPlugins>, CancellationToken)

Create a telegraf config.

Declaration

public Task<Telegraf> CreateTelegrafAsync(string name, string description, string orgId, string config, TelegrafRequestMetadata metadata, List<TelegrafPluginRequestPlugins> plugins = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	name	Telegraf Configuration Name
System.String	description	Telegraf Configuration Description
System.String	orgId	The organization that owns this config
System.String	config	ConfigTOML contains the raw toml config
TelegrafRequestMetadata	metadata	Metadata for the config
List<TelegrafPluginRequestPlugins>	plugins	Plugins to use.
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
Task<Telegraf>	Telegraf config created

DeleteLabelAsync(Label, Telegraf, CancellationToken)

Delete a label from a telegraf config.

Declaration

public Task DeleteLabelAsync(Label label, Telegraf telegraf, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
Label	label	label to delete
Telegraf	telegraf	the telegraf config
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
Task	delete has been accepted

DeleteLabelAsync(String, String, CancellationToken)

Delete a label from a telegraf config.

Declaration

public Task DeleteLabelAsync(string labelId, string telegrafId, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	labelId	ID of label to delete
System.String	telegrafId	ID of the telegraf config
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
Task	delete has been accepted

DeleteMemberAsync(User, Telegraf, CancellationToken)

Removes a member from a telegraf config.

Declaration

public Task DeleteMemberAsync(User member, Telegraf telegraf, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
User	member	member to remove
Telegraf	telegraf	the telegraf
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
Task	member removed

DeleteMemberAsync(String, String, CancellationToken)

Removes a member from a telegraf config.

Declaration

public Task DeleteMemberAsync(string memberId, string telegrafId, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	memberId	ID of member to remove
System.String	telegrafId	ID of the telegraf
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
Task	member removed

DeleteOwnerAsync(User, Telegraf, CancellationToken)

Removes an owner from a telegraf config.

Declaration

public Task DeleteOwnerAsync(User owner, Telegraf telegraf, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
User	owner	owner to remove
Telegraf	telegraf	the telegraf config
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
Task	owner removed

DeleteOwnerAsync(String, String, CancellationToken)

Removes an owner from a telegraf config.

Declaration

public Task DeleteOwnerAsync(string ownerId, string telegrafId, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	ownerId	ID of owner to remove
System.String	telegrafId	ID of the telegraf config
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
Task	owner removed

DeleteTelegrafAsync(Telegraf, CancellationToken)

Delete a telegraf config.

Declaration

public Task DeleteTelegrafAsync(Telegraf telegraf, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
Telegraf	telegraf	telegraf config to delete
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
Task	delete has been accepted

DeleteTelegrafAsync(String, CancellationToken)

Delete a telegraf config.

Declaration

public Task DeleteTelegrafAsync(string telegrafId, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	telegrafId	ID of telegraf config to delete
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
Task	delete has been accepted

FindTelegrafByIdAsync(String, CancellationToken)

Retrieve a telegraf config.

Declaration

public async Task<Telegraf> FindTelegrafByIdAsync(string telegrafId, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	telegrafId	ID of telegraf config to get
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
Task<Telegraf>	telegraf config details

FindTelegrafsAsync(CancellationToken)

Returns a list of telegraf configs.

Declaration

public Task<List<Telegraf>> FindTelegrafsAsync(CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
Task<List<Telegraf>>	A list of telegraf configs

FindTelegrafsByOrgAsync(Organization, CancellationToken)

Returns a list of telegraf configs for specified organization.

Declaration

public Task<List<Telegraf>> FindTelegrafsByOrgAsync(Organization organization, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
Organization	organization	specifies the organization of the telegraf configs
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
Task<List<Telegraf>>	A list of telegraf configs

FindTelegrafsByOrgIdAsync(String, CancellationToken)

Returns a list of telegraf configs for specified organization.

Declaration

public async Task<List<Telegraf>> FindTelegrafsByOrgIdAsync(string orgId, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	orgId	specifies the organization of the telegraf configs
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
Task<List<Telegraf>>	A list of telegraf configs

GetLabelsAsync(Telegraf, CancellationToken)

List all labels for a telegraf config.

Declaration

public Task<List<Label>> GetLabelsAsync(Telegraf telegraf, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
Telegraf	telegraf	the telegraf config
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
Task<List<Label>>	a list of all labels for a telegraf config

GetLabelsAsync(String, CancellationToken)

List all labels for a telegraf config.

Declaration

public async Task<List<Label>> GetLabelsAsync(string telegrafId, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	telegrafId	ID of the telegraf config
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
Task<List<Label>>	a list of all labels for a telegraf config

GetMembersAsync(Telegraf, CancellationToken)

List all users with member privileges for a telegraf config.

Declaration

public Task<List<ResourceMember>> GetMembersAsync(Telegraf telegraf, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
Telegraf	telegraf	the telegraf config
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
Task<List<ResourceMember>>	a list of telegraf config members

GetMembersAsync(String, CancellationToken)

List all users with member privileges for a telegraf config.

Declaration

public async Task<List<ResourceMember>> GetMembersAsync(string telegrafId, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	telegrafId	ID of the telegraf config
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
Task<List<ResourceMember>>	a list of telegraf config members

GetOwnersAsync(Telegraf, CancellationToken)

List all owners of a telegraf config.

Declaration

public Task<List<ResourceOwner>> GetOwnersAsync(Telegraf telegraf, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
Telegraf	telegraf	the telegraf config
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
Task<List<ResourceOwner>>	a list of telegraf config owners

GetOwnersAsync(String, CancellationToken)

List all owners of a telegraf config.

Declaration

public async Task<List<ResourceOwner>> GetOwnersAsync(string telegrafId, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	telegrafId	ID of the telegraf config
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
Task<List<ResourceOwner>>	a list of telegraf config owners

GetTOMLAsync(Telegraf, CancellationToken)

Retrieve a telegraf config in TOML.

Declaration

public Task<string> GetTOMLAsync(Telegraf telegraf, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
Telegraf	telegraf	telegraf config to get
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
Task<System.String>	telegraf config details in TOML format

GetTOMLAsync(String, CancellationToken)

Retrieve a telegraf config in TOML.

Declaration

public Task<string> GetTOMLAsync(string telegrafId, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	telegrafId	ID of telegraf config to get
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
Task<System.String>	telegraf config details in TOML format

UpdateTelegrafAsync(Telegraf, CancellationToken)

Update a telegraf config.

Declaration

public Task<Telegraf> UpdateTelegrafAsync(Telegraf telegraf, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
Telegraf	telegraf	telegraf config update to apply
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
Task<Telegraf>	An updated telegraf

UpdateTelegrafAsync(String, TelegrafPluginRequest, CancellationToken)

Update a telegraf config.

Declaration

public Task<Telegraf> UpdateTelegrafAsync(string telegrafId, TelegrafPluginRequest telegrafRequest, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	telegrafId	ID of telegraf config
TelegrafPluginRequest	telegrafRequest	telegraf config update to apply
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
Task<Telegraf>	An updated telegraf

Implements

ITelegrafsApi