com.influxdb.client.service

Interface VariablesService

public interface VariablesService

Method Summary

Modifier and Type	Method and 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 Detail

deleteVariablesID

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

Delete a variable

Parameters:

variableID - The variable ID. (required)

zapTraceSpan - OpenTracing span context (optional)

Returns:

Call<Void>

deleteVariablesIDLabelsID

@DELETE(value="api/v2/variables/{variableID}/labels/{labelID}")
retrofit2.Call<Void> deleteVariablesIDLabelsID(@Path(value="variableID")
                                                                                                               String variableID,
                                                                                                               @Path(value="labelID")
                                                                                                               String labelID,
                                                                                                               @Header(value="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(value="api/v2/variables")
retrofit2.Call<Variables> getVariables(@Header(value="Zap-Trace-Span")
                                                                      String zapTraceSpan,
                                                                      @Query(value="org")
                                                                      String org,
                                                                      @Query(value="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(value="api/v2/variables/{variableID}")
retrofit2.Call<Variable> getVariablesID(@Path(value="variableID")
                                                                                    String variableID,
                                                                                    @Header(value="Zap-Trace-Span")
                                                                                    String zapTraceSpan)

Retrieve a variable

Parameters:

variableID - The variable ID. (required)

zapTraceSpan - OpenTracing span context (optional)

Returns:

Call<Variable>

getVariablesIDLabels

@GET(value="api/v2/variables/{variableID}/labels")
retrofit2.Call<LabelsResponse> getVariablesIDLabels(@Path(value="variableID")
                                                                                                       String variableID,
                                                                                                       @Header(value="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(value="Content-Type:application/json")
 @PATCH(value="api/v2/variables/{variableID}")
retrofit2.Call<Variable> patchVariablesID(@Path(value="variableID")
                                                                                                                                         String variableID,
                                                                                                                                         @Body
                                                                                                                                         Variable variable,
                                                                                                                                         @Header(value="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(value="Content-Type:application/json")
 @POST(value="api/v2/variables")
retrofit2.Call<Variable> postVariables(@Body
                                                                                                                        Variable variable,
                                                                                                                        @Header(value="Zap-Trace-Span")
                                                                                                                        String zapTraceSpan)

Create a variable

Parameters:

variable - Variable to create (required)

zapTraceSpan - OpenTracing span context (optional)

Returns:

Call<Variable>

postVariablesIDLabels

@Headers(value="Content-Type:application/json")
 @POST(value="api/v2/variables/{variableID}/labels")
retrofit2.Call<LabelResponse> postVariablesIDLabels(@Path(value="variableID")
                                                                                                                                                         String variableID,
                                                                                                                                                         @Body
                                                                                                                                                         LabelMapping labelMapping,
                                                                                                                                                         @Header(value="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(value="Content-Type:application/json")
 @PUT(value="api/v2/variables/{variableID}")
retrofit2.Call<Variable> putVariablesID(@Path(value="variableID")
                                                                                                                                     String variableID,
                                                                                                                                     @Body
                                                                                                                                     Variable variable,
                                                                                                                                     @Header(value="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>