Package com.influxdb.client.service

Interface TelegrafsService

public interface TelegrafsService

Method Summary

Modifier and Type	Method	Description
retrofit2.Call<Void>	deleteTelegrafsID(String telegrafID, String zapTraceSpan)	Delete a Telegraf configuration
retrofit2.Call<Void>	deleteTelegrafsIDLabelsID(String telegrafID, String labelID, String zapTraceSpan)	Delete a label from a Telegraf config
retrofit2.Call<Void>	deleteTelegrafsIDMembersID(String userID, String telegrafID, String zapTraceSpan)	Remove a member from a Telegraf config
retrofit2.Call<Void>	deleteTelegrafsIDOwnersID(String userID, String telegrafID, String zapTraceSpan)	Remove an owner from a Telegraf config
retrofit2.Call<Telegrafs>	getTelegrafs(String zapTraceSpan, String orgID)	List all Telegraf configurations
retrofit2.Call<String>	getTelegrafsID(String telegrafID, String zapTraceSpan, String accept)	Retrieve a Telegraf configuration
retrofit2.Call<LabelsResponse>	getTelegrafsIDLabels(String telegrafID, String zapTraceSpan)	List all labels for a Telegraf config
retrofit2.Call<ResourceMembers>	getTelegrafsIDMembers(String telegrafID, String zapTraceSpan)	List all users with member privileges for a Telegraf config
retrofit2.Call<ResourceOwners>	getTelegrafsIDOwners(String telegrafID, String zapTraceSpan)	List all owners of a Telegraf configuration
retrofit2.Call<okhttp3.ResponseBody>	getTelegrafsIDResponseBody(String telegrafID, String zapTraceSpan, String accept)	Retrieve a Telegraf configuration
retrofit2.Call<String>	getTelegrafsIDString(String telegrafID, String zapTraceSpan, String accept)	Retrieve a Telegraf configuration
retrofit2.Call<Telegraf>	getTelegrafsIDTelegraf(String telegrafID, String zapTraceSpan, String accept)	Retrieve a Telegraf configuration
retrofit2.Call<Telegraf>	postTelegrafs(TelegrafPluginRequest telegrafPluginRequest, String zapTraceSpan)	Create a Telegraf configuration
retrofit2.Call<LabelResponse>	postTelegrafsIDLabels(String telegrafID, LabelMapping labelMapping, String zapTraceSpan)	Add a label to a Telegraf config
retrofit2.Call<ResourceMember>	postTelegrafsIDMembers(String telegrafID, AddResourceMemberRequestBody addResourceMemberRequestBody, String zapTraceSpan)	Add a member to a Telegraf config
retrofit2.Call<ResourceOwner>	postTelegrafsIDOwners(String telegrafID, AddResourceMemberRequestBody addResourceMemberRequestBody, String zapTraceSpan)	Add an owner to a Telegraf configuration
retrofit2.Call<Telegraf>	putTelegrafsID(String telegrafID, TelegrafPluginRequest telegrafPluginRequest, String zapTraceSpan)	Update a Telegraf configuration

Method Details

deleteTelegrafsID

@DELETE("api/v2/telegrafs/{telegrafID}")
retrofit2.Call<Void> deleteTelegrafsID(@Path("telegrafID")
 String telegrafID,
 @Header("Zap-Trace-Span")
 String zapTraceSpan)

Delete a Telegraf configuration

Parameters:

telegrafID - The Telegraf configuration ID. (required)

zapTraceSpan - OpenTracing span context (optional)

Returns:

Call<Void>

deleteTelegrafsIDLabelsID

@DELETE("api/v2/telegrafs/{telegrafID}/labels/{labelID}")
retrofit2.Call<Void> deleteTelegrafsIDLabelsID(@Path("telegrafID")
 String telegrafID,
 @Path("labelID")
 String labelID,
 @Header("Zap-Trace-Span")
 String zapTraceSpan)

Delete a label from a Telegraf config

Parameters:

telegrafID - The Telegraf config ID. (required)

labelID - The label ID. (required)

zapTraceSpan - OpenTracing span context (optional)

Returns:

Call<Void>

deleteTelegrafsIDMembersID

@DELETE("api/v2/telegrafs/{telegrafID}/members/{userID}")
retrofit2.Call<Void> deleteTelegrafsIDMembersID(@Path("userID")
 String userID,
 @Path("telegrafID")
 String telegrafID,
 @Header("Zap-Trace-Span")
 String zapTraceSpan)

Remove a member from a Telegraf config

Parameters:

userID - The ID of the member to remove. (required)

telegrafID - The Telegraf config ID. (required)

zapTraceSpan - OpenTracing span context (optional)

Returns:

Call<Void>

deleteTelegrafsIDOwnersID

@DELETE("api/v2/telegrafs/{telegrafID}/owners/{userID}")
retrofit2.Call<Void> deleteTelegrafsIDOwnersID(@Path("userID")
 String userID,
 @Path("telegrafID")
 String telegrafID,
 @Header("Zap-Trace-Span")
 String zapTraceSpan)

Remove an owner from a Telegraf config

Parameters:

userID - The ID of the owner to remove. (required)

telegrafID - The Telegraf config ID. (required)

zapTraceSpan - OpenTracing span context (optional)

Returns:

Call<Void>

getTelegrafs

@GET("api/v2/telegrafs")
retrofit2.Call<Telegrafs> getTelegrafs(@Header("Zap-Trace-Span")
 String zapTraceSpan,
 @Query("orgID")
 String orgID)

List all Telegraf configurations

Parameters:

zapTraceSpan - OpenTracing span context (optional)

orgID - The organization ID the Telegraf config belongs to. (optional)

Returns:

Call<Telegrafs>

getTelegrafsID

@GET("api/v2/telegrafs/{telegrafID}")
retrofit2.Call<String> getTelegrafsID(@Path("telegrafID")
 String telegrafID,
 @Header("Zap-Trace-Span")
 String zapTraceSpan,
 @Header("Accept")
 String accept)

Retrieve a Telegraf configuration

Parameters:

telegrafID - The Telegraf configuration ID. (required)

zapTraceSpan - OpenTracing span context (optional)

accept - (optional, default to application/toml)

Returns:

Call<String>

getTelegrafsIDResponseBody

@GET("api/v2/telegrafs/{telegrafID}")
retrofit2.Call<okhttp3.ResponseBody> getTelegrafsIDResponseBody(@Path("telegrafID")
 String telegrafID,
 @Header("Zap-Trace-Span")
 String zapTraceSpan,
 @Header("Accept")
 String accept)

Retrieve a Telegraf configuration

Parameters:

telegrafID - The Telegraf configuration ID. (required)

zapTraceSpan - OpenTracing span context (optional)

accept - (optional, default to application/toml)

Returns:

Call<ResponseBody>

getTelegrafsIDString

@GET("api/v2/telegrafs/{telegrafID}")
retrofit2.Call<String> getTelegrafsIDString(@Path("telegrafID")
 String telegrafID,
 @Header("Zap-Trace-Span")
 String zapTraceSpan,
 @Header("Accept")
 String accept)

Retrieve a Telegraf configuration

Parameters:

telegrafID - The Telegraf configuration ID. (required)

zapTraceSpan - OpenTracing span context (optional)

accept - (optional, default to application/toml)

Returns:

Call<String>

getTelegrafsIDTelegraf

@GET("api/v2/telegrafs/{telegrafID}")
retrofit2.Call<Telegraf> getTelegrafsIDTelegraf(@Path("telegrafID")
 String telegrafID,
 @Header("Zap-Trace-Span")
 String zapTraceSpan,
 @Header("Accept")
 String accept)

Retrieve a Telegraf configuration

Parameters:

telegrafID - The Telegraf configuration ID. (required)

zapTraceSpan - OpenTracing span context (optional)

accept - (optional, default to application/toml)

Returns:

Call<Telegraf>

getTelegrafsIDLabels

@GET("api/v2/telegrafs/{telegrafID}/labels")
retrofit2.Call<LabelsResponse> getTelegrafsIDLabels(@Path("telegrafID")
 String telegrafID,
 @Header("Zap-Trace-Span")
 String zapTraceSpan)

List all labels for a Telegraf config

Parameters:

telegrafID - The Telegraf config ID. (required)

zapTraceSpan - OpenTracing span context (optional)

Returns:

Call<LabelsResponse>

getTelegrafsIDMembers

@GET("api/v2/telegrafs/{telegrafID}/members")
retrofit2.Call<ResourceMembers> getTelegrafsIDMembers(@Path("telegrafID")
 String telegrafID,
 @Header("Zap-Trace-Span")
 String zapTraceSpan)

List all users with member privileges for a Telegraf config

Parameters:

telegrafID - The Telegraf config ID. (required)

zapTraceSpan - OpenTracing span context (optional)

Returns:

Call<ResourceMembers>

getTelegrafsIDOwners

@GET("api/v2/telegrafs/{telegrafID}/owners")
retrofit2.Call<ResourceOwners> getTelegrafsIDOwners(@Path("telegrafID")
 String telegrafID,
 @Header("Zap-Trace-Span")
 String zapTraceSpan)

List all owners of a Telegraf configuration

Parameters:

telegrafID - The Telegraf configuration ID. (required)

zapTraceSpan - OpenTracing span context (optional)

Returns:

Call<ResourceOwners>

postTelegrafs

@Headers("Content-Type:application/json")
@POST("api/v2/telegrafs")
retrofit2.Call<Telegraf> postTelegrafs(@Body
 TelegrafPluginRequest telegrafPluginRequest,
 @Header("Zap-Trace-Span")
 String zapTraceSpan)

Create a Telegraf configuration

Parameters:

telegrafPluginRequest - Telegraf configuration to create (required)

zapTraceSpan - OpenTracing span context (optional)

Returns:

Call<Telegraf>

postTelegrafsIDLabels

@Headers("Content-Type:application/json")
@POST("api/v2/telegrafs/{telegrafID}/labels")
retrofit2.Call<LabelResponse> postTelegrafsIDLabels(@Path("telegrafID")
 String telegrafID,
 @Body
 LabelMapping labelMapping,
 @Header("Zap-Trace-Span")
 String zapTraceSpan)

Add a label to a Telegraf config

Parameters:

telegrafID - The Telegraf config ID. (required)

labelMapping - Label to add (required)

zapTraceSpan - OpenTracing span context (optional)

Returns:

Call<LabelResponse>

postTelegrafsIDMembers

@Headers("Content-Type:application/json")
@POST("api/v2/telegrafs/{telegrafID}/members")
retrofit2.Call<ResourceMember> postTelegrafsIDMembers(@Path("telegrafID")
 String telegrafID,
 @Body
 AddResourceMemberRequestBody addResourceMemberRequestBody,
 @Header("Zap-Trace-Span")
 String zapTraceSpan)

Add a member to a Telegraf config

Parameters:

telegrafID - The Telegraf config ID. (required)

addResourceMemberRequestBody - User to add as member (required)

zapTraceSpan - OpenTracing span context (optional)

Returns:

Call<ResourceMember>

postTelegrafsIDOwners

@Headers("Content-Type:application/json")
@POST("api/v2/telegrafs/{telegrafID}/owners")
retrofit2.Call<ResourceOwner> postTelegrafsIDOwners(@Path("telegrafID")
 String telegrafID,
 @Body
 AddResourceMemberRequestBody addResourceMemberRequestBody,
 @Header("Zap-Trace-Span")
 String zapTraceSpan)

Add an owner to a Telegraf configuration

Parameters:

telegrafID - The Telegraf configuration ID. (required)

addResourceMemberRequestBody - User to add as owner (required)

zapTraceSpan - OpenTracing span context (optional)

Returns:

Call<ResourceOwner>

putTelegrafsID

@Headers("Content-Type:application/json")
@PUT("api/v2/telegrafs/{telegrafID}")
retrofit2.Call<Telegraf> putTelegrafsID(@Path("telegrafID")
 String telegrafID,
 @Body
 TelegrafPluginRequest telegrafPluginRequest,
 @Header("Zap-Trace-Span")
 String zapTraceSpan)

Update a Telegraf configuration

Parameters:

telegrafID - The Telegraf config ID. (required)

telegrafPluginRequest - Telegraf configuration update to apply (required)

zapTraceSpan - OpenTracing span context (optional)

Returns:

Call<Telegraf>