Package com.influxdb.client.service

Interface VariablesService

public interface VariablesService

Method Summary

Modifier and Type	Method	Description
retrofit2.Call<Void>	deleteVariablesID(String variableID, String zapTraceSpan)	Delete a variable
retrofit2.Call<Void>	deleteVariablesIDLabelsID(String variableID, String labelID, String zapTraceSpan)	Delete a label from a variable
retrofit2.Call<Variables>	getVariables(String zapTraceSpan, String org, String orgID)	List all variables
retrofit2.Call<Variable>	getVariablesID(String variableID, String zapTraceSpan)	Retrieve a variable
retrofit2.Call<LabelsResponse>	getVariablesIDLabels(String variableID, String zapTraceSpan)	List all labels for a variable
retrofit2.Call<Variable>	patchVariablesID(String variableID, Variable variable, String zapTraceSpan)	Update a variable
retrofit2.Call<Variable>	postVariables(Variable variable, String zapTraceSpan)	Create a variable
retrofit2.Call<LabelResponse>	postVariablesIDLabels(String variableID, LabelMapping labelMapping, String zapTraceSpan)	Add a label to a variable
retrofit2.Call<Variable>	putVariablesID(String variableID, Variable variable, String zapTraceSpan)	Replace a variable

Method Details

deleteVariablesID

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

Delete a variable

Parameters:

variableID - The variable ID. (required)

zapTraceSpan - OpenTracing span context (optional)

Returns:

Call<Void>

deleteVariablesIDLabelsID

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

Delete a label from a variable

Parameters:

variableID - The variable ID. (required)

labelID - The label ID to delete. (required)

zapTraceSpan - OpenTracing span context (optional)

Returns:

Call<Void>

getVariables

@GET("api/v2/variables")
retrofit2.Call<Variables> getVariables(@Header("Zap-Trace-Span")
 String zapTraceSpan,
 @Query("org")
 String org,
 @Query("orgID")
 String orgID)

List all variables

Parameters:

zapTraceSpan - OpenTracing span context (optional)

org - The name of the organization. (optional)

orgID - The organization ID. (optional)

Returns:

Call<Variables>

getVariablesID

@GET("api/v2/variables/{variableID}")
retrofit2.Call<Variable> getVariablesID(@Path("variableID")
 String variableID,
 @Header("Zap-Trace-Span")
 String zapTraceSpan)

Retrieve a variable

Parameters:

variableID - The variable ID. (required)

zapTraceSpan - OpenTracing span context (optional)

Returns:

Call<Variable>

getVariablesIDLabels

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

List all labels for a variable

Parameters:

variableID - The variable ID. (required)

zapTraceSpan - OpenTracing span context (optional)

Returns:

Call<LabelsResponse>

patchVariablesID

@Headers("Content-Type:application/json")
@PATCH("api/v2/variables/{variableID}")
retrofit2.Call<Variable> patchVariablesID(@Path("variableID")
 String variableID,
 @Body
 Variable variable,
 @Header("Zap-Trace-Span")
 String zapTraceSpan)

Update a variable

Parameters:

variableID - The variable ID. (required)

variable - Variable update to apply (required)

zapTraceSpan - OpenTracing span context (optional)

Returns:

Call<Variable>

postVariables

@Headers("Content-Type:application/json")
@POST("api/v2/variables")
retrofit2.Call<Variable> postVariables(@Body
 Variable variable,
 @Header("Zap-Trace-Span")
 String zapTraceSpan)

Create a variable

Parameters:

variable - Variable to create (required)

zapTraceSpan - OpenTracing span context (optional)

Returns:

Call<Variable>

postVariablesIDLabels

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

Add a label to a variable

Parameters:

variableID - The variable ID. (required)

labelMapping - Label to add (required)

zapTraceSpan - OpenTracing span context (optional)

Returns:

Call<LabelResponse>

putVariablesID

@Headers("Content-Type:application/json")
@PUT("api/v2/variables/{variableID}")
retrofit2.Call<Variable> putVariablesID(@Path("variableID")
 String variableID,
 @Body
 Variable variable,
 @Header("Zap-Trace-Span")
 String zapTraceSpan)

Replace a variable

Parameters:

variableID - The variable ID. (required)

variable - Variable to replace (required)

zapTraceSpan - OpenTracing span context (optional)

Returns:

Call<Variable>