com.influxdb.client

Interface VariablesApi

public interface VariablesApi

The client of the InfluxDB 2.0 that implement Variables HTTP API endpoint.

Author:

Jakub Bednar (27/03/2019 09:35)

Method Summary

Modifier and Type	Method and Description
Label	addLabel(Label label, Variable variable) Add a label to a variable.
Label	addLabel(String labelID, String variableID) Add a label to a variable.
Variable	cloneVariable(String clonedName, String variableID) Clone a variable.
Variable	cloneVariable(String clonedName, Variable variable) Clone a variable.
Variable	createVariable(Variable variable) Create a variable.
void	deleteLabel(Label label, Variable variable) Delete a label from a variable.
void	deleteLabel(String labelID, String variableID) Delete a label from a variable.
void	deleteVariable(String variableID) Delete a variable.
void	deleteVariable(Variable variable) Delete a variable.
Variable	findVariableByID(String variableID) Get a variable.
List<Variable>	findVariables(Organization organization) Get all variables.
List<Variable>	findVariables(String orgID) Get all variables.
List<Label>	getLabels(String variableID) List all labels for a variable.
List<Label>	getLabels(Variable variable) List all labels for a variable.
Variable	updateVariable(Variable variable) Update a variable.

Method Detail

createVariable

@Nonnull
Variable createVariable(@Nonnull
                                 Variable variable)

Create a variable.

Parameters:

variable - variable to create

Returns:

variable created

updateVariable

@Nonnull
Variable updateVariable(@Nonnull
                                 Variable variable)

Update a variable.

Parameters:

variable - variable update to apply

Returns:

variable updated

deleteVariable

void deleteVariable(@Nonnull
                    Variable variable)

Delete a variable.

Parameters:

variable - variable to delete

deleteVariable

void deleteVariable(@Nonnull
                    String variableID)

Delete a variable.

Parameters:

variableID - id of the variable

cloneVariable

@Nonnull
Variable cloneVariable(@Nonnull
                                String clonedName,
                                @Nonnull
                                String variableID)

Clone a variable.

Parameters:

clonedName - name of cloned variable

variableID - ID of variable to clone

Returns:

cloned variable

cloneVariable

@Nonnull
Variable cloneVariable(@Nonnull
                                String clonedName,
                                @Nonnull
                                Variable variable)

Clone a variable.

Parameters:

clonedName - name of cloned variable

variable - variable to clone

Returns:

cloned variable

findVariableByID

@Nonnull
Variable findVariableByID(@Nonnull
                                   String variableID)

Get a variable.

Parameters:

variableID - ID of the variable (required)

Returns:

variable found

findVariables

@Nonnull
List<Variable> findVariables(@Nonnull
                                      Organization organization)

Get all variables.

Parameters:

organization - specifies the organization of the resource

Returns:

all variables for an organization

findVariables

@Nonnull
List<Variable> findVariables(@Nonnull
                                      String orgID)

Get all variables.

Parameters:

orgID - specifies the organization id of the resource

Returns:

all variables for an organization

getLabels

@Nonnull
List<Label> getLabels(@Nonnull
                               Variable variable)

List all labels for a variable.

Parameters:

variable - the variable

Returns:

a list of all labels for a variable

getLabels

@Nonnull
List<Label> getLabels(@Nonnull
                               String variableID)

List all labels for a variable.

Parameters:

variableID - ID of the variable

Returns:

a list of all labels for a variable

addLabel

@Nonnull
Label addLabel(@Nonnull
                        Label label,
                        @Nonnull
                        Variable variable)

Add a label to a variable.

Parameters:

label - label to add

variable - the variable

Returns:

a list of all labels for a variable

addLabel

@Nonnull
Label addLabel(@Nonnull
                        String labelID,
                        @Nonnull
                        String variableID)

Add a label to a variable.

Parameters:

variableID - ID of the variable

labelID - the ID of label to add

Returns:

a list of all labels for a variable

deleteLabel

void deleteLabel(@Nonnull
                 Label label,
                 @Nonnull
                 Variable variable)

Delete a label from a variable.

Parameters:

label - the label to delete

variable - the variable

deleteLabel

void deleteLabel(@Nonnull
                 String labelID,
                 @Nonnull
                 String variableID)

Delete a label from a variable.

Parameters:

variableID - ID of the variable

labelID - the ID of a label