Package com.influxdb.client

Interface VariablesApi

@ThreadSafe public interface VariablesApi
The client of the InfluxDB 2.x that implement Variables HTTP API endpoint.
Author:
Jakub Bednar (27/03/2019 09:35)

  • Method Details

    • 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:
      labelID - the ID of label to add
      variableID - ID of the variable
      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:
      labelID - the ID of a label
      variableID - ID of the variable