Package com.influxdb.client

Interface DashboardsApi

@ThreadSafe public interface DashboardsApi
The client of the InfluxDB 2.x that implement Dashboards HTTP API endpoint.
Author:
Jakub Bednar (bednar@github) (01/04/2019 10:47)

  • Method Details

    • createDashboard

      Dashboard createDashboard(@Nonnull String name, @Nullable String description, @Nonnull String orgID)
      Create a dashboard.
      Parameters:
      name - user-facing name of the dashboard
      description - user-facing description of the dashboard
      orgID - id of the organization that owns the dashboard
      Returns:
      created Dashboard

    • createDashboard

      @Nonnull Dashboard createDashboard(@Nonnull CreateDashboardRequest createDashboardRequest)
      Create a dashboard.
      Parameters:
      createDashboardRequest - dashboard to create
      Returns:
      created Dashboard

    • updateDashboard

      @Nonnull Dashboard updateDashboard(@Nonnull Dashboard dashboard)
      Update a single dashboard.
      Parameters:
      dashboard - patching of a dashboard
      Returns:
      Updated dashboard

    • deleteDashboard

      void deleteDashboard(@Nonnull Dashboard dashboard)
      Delete a dashboard.
      Parameters:
      dashboard - dashboard to delete

    • deleteDashboard

      void deleteDashboard(@Nonnull String dashboardID)
      Delete a dashboard.
      Parameters:
      dashboardID - ID of dashboard to delete

    • findDashboardByID

      @Nonnull Dashboard findDashboardByID(@Nonnull String dashboardID)
      Get a single Dashboard.
      Parameters:
      dashboardID - ID of dashboard to get
      Returns:
      a single dashboard

    • findDashboards

      @Nonnull List<Dashboard> findDashboards()
      Get all dashboards.
      Returns:
      a list of dashboard

    • findDashboardsByOrganization

      @Nonnull List<Dashboard> findDashboardsByOrganization(@Nonnull Organization organization)
      Get dashboards.
      Parameters:
      organization - filter dashboards to a specific organization
      Returns:
      a list of dashboard

    • findDashboardsByOrgName

      @Nonnull List<Dashboard> findDashboardsByOrgName(@Nullable String orgName)
      Get dashboards.
      Parameters:
      orgName - filter dashboards to a specific organization name
      Returns:
      a list of dashboard

    • getMembers

      @Nonnull List<ResourceMember> getMembers(@Nonnull Dashboard dashboard)
      List all dashboard members.
      Parameters:
      dashboard - the dashboard
      Returns:
      a list of users who have member privileges for a dashboard

    • getMembers

      @Nonnull List<ResourceMember> getMembers(@Nonnull String dashboardID)
      List all dashboard members.
      Parameters:
      dashboardID - ID of the dashboard
      Returns:
      a list of users who have member privileges for a dashboard

    • addMember

      @Nonnull ResourceMember addMember(@Nonnull User member, @Nonnull Dashboard dashboard)
      Add dashboard member.
      Parameters:
      member - user to add as member
      dashboard - the dashboard
      Returns:
      added to dashboard members

    • addMember

      @Nonnull ResourceMember addMember(@Nonnull String memberID, @Nonnull String dashboardID)
      Add dashboard member.
      Parameters:
      memberID - user to add as member
      dashboardID - ID of the dashboard
      Returns:
      added to dashboard members

    • deleteMember

      void deleteMember(@Nonnull User member, @Nonnull Dashboard dashboard)
      Removes a member from an dashboard.
      Parameters:
      member - member to remove
      dashboard - the dashboard

    • deleteMember

      void deleteMember(@Nonnull String memberID, @Nonnull String dashboardID)
      Removes a member from an dashboard.
      Parameters:
      memberID - ID of member to remove
      dashboardID - ID of the dashboard

    • getOwners

      @Nonnull List<ResourceOwner> getOwners(@Nonnull Dashboard dashboard)
      List all dashboard owners.
      Parameters:
      dashboard - the dashboard
      Returns:
      a list of users who have owner privileges for a dashboard

    • getOwners

      @Nonnull List<ResourceOwner> getOwners(@Nonnull String dashboardID)
      List all dashboard owners.
      Parameters:
      dashboardID - ID of the dashboard
      Returns:
      a list of users who have owner privileges for a dashboard

    • addOwner

      @Nonnull ResourceOwner addOwner(@Nonnull User owner, @Nonnull Dashboard dashboard)
      Add dashboard owner.
      Parameters:
      owner - user to add as owner
      dashboard - the dashboard
      Returns:
      added to dashboard owners

    • addOwner

      @Nonnull ResourceOwner addOwner(@Nonnull String ownerID, @Nonnull String dashboardID)
      Add dashboard owner.
      Parameters:
      ownerID - user to add as owner
      dashboardID - ID of the dashboard
      Returns:
      added to dashboard owners

    • deleteOwner

      void deleteOwner(@Nonnull User owner, @Nonnull Dashboard dashboard)
      Removes an owner from a dashboard.
      Parameters:
      owner - owner to remove
      dashboard - the dashboard

    • deleteOwner

      void deleteOwner(@Nonnull String ownerID, @Nonnull String dashboardID)
      Removes an owner from a dashboard.
      Parameters:
      ownerID - ID of owner to remove
      dashboardID - ID of the dashboard

    • getLabels

      @Nonnull List<Label> getLabels(@Nonnull Dashboard dashboard)
      List all labels for a dashboard.
      Parameters:
      dashboard - the dashboard
      Returns:
      a list of all labels for a dashboard

    • getLabels

      @Nonnull List<Label> getLabels(@Nonnull String dashboardID)
      List all labels for a dashboard.
      Parameters:
      dashboardID - ID of the dashboard
      Returns:
      a list of all labels for a dashboard

    • addLabel

      @Nonnull LabelResponse addLabel(@Nonnull Label label, @Nonnull Dashboard dashboard)
      Add a label to a dashboard.
      Parameters:
      label - label to add
      dashboard - the dashboard
      Returns:
      the label added to the dashboard

    • addLabel

      @Nonnull LabelResponse addLabel(@Nonnull String labelID, @Nonnull String dashboardID)
      Add a label to a dashboard.
      Parameters:
      labelID - label ID to add
      dashboardID - ID of the dashboard
      Returns:
      the label added to the dashboard

    • deleteLabel

      void deleteLabel(@Nonnull Label label, @Nonnull Dashboard dashboard)
      Delete a label from a dashboard.
      Parameters:
      label - the label to delete
      dashboard - the dashboard

    • deleteLabel

      void deleteLabel(@Nonnull String labelID, @Nonnull String dashboardID)
      Delete a label from a dashboard.
      Parameters:
      labelID - the label id to delete
      dashboardID - ID of the dashboard

    • addCell

      @Nonnull Cell addCell(@Nonnull CreateCell createCell, @Nonnull Dashboard dashboard)
      Create a dashboard cell.
      Parameters:
      createCell - cell that will be added
      dashboard - dashboard to update
      Returns:
      Cell successfully added

    • addCell

      @Nonnull Cell addCell(@Nonnull CreateCell createCell, @Nonnull String dashboardID)
      Create a dashboard cell.
      Parameters:
      createCell - cell that will be added
      dashboardID - ID of dashboard to update
      Returns:
      Cell successfully added

    • updateCell

      @Nonnull Cell updateCell(@Nonnull CellUpdate cellUpdate, @Nonnull String cellID, @Nonnull String dashboardID)
      Update the non positional information related to a cell (because updates to a single cells positional data could cause grid conflicts).
      Parameters:
      cellUpdate - updates the non positional information related to a cell
      cellID - ID of cell to update
      dashboardID - ID of dashboard to update
      Returns:
      Updated dashboard cell

    • deleteCell

      void deleteCell(@Nonnull Cell cell, @Nonnull Dashboard dashboard)
      Delete a dashboard cell.
      Parameters:
      cell - cell to delete
      dashboard - dashboard to delete

    • deleteCell

      void deleteCell(@Nonnull String cellID, @Nonnull String dashboardID)
      Delete a dashboard cell.
      Parameters:
      cellID - ID of cell to delete
      dashboardID - ID of dashboard to delete

    • replaceCells

      @Nonnull Dashboard replaceCells(@Nonnull List<Cell> cells, @Nonnull Dashboard dashboard)
      Replace a dashboards cells.
      Parameters:
      cells - batch replaces all of a dashboards cells (this is used primarily to update the positional information of all of the cells)
      dashboard - dashboard to update
      Returns:
      Replaced dashboard cells

    • replaceCells

      @Nonnull Dashboard replaceCells(@Nonnull List<Cell> cells, @Nonnull String dashboardID)
      Replace a dashboards cells.
      Parameters:
      cells - batch replaces all of a dashboards cells (this is used primarily to update the positional information of all of the cells)
      dashboardID - ID of dashboard to update
      Returns:
      Replaced dashboard cells

    • addCellView

      @Nonnull View addCellView(@Nonnull View view, @Nonnull Cell cell, @Nonnull Dashboard dashboard)
      Add the view to a cell.
      Parameters:
      view - the view for a cell
      cell - cell to update
      dashboard - dashboard to update
      Returns:
      Added cell view

    • addCellView

      @Nonnull View addCellView(@Nonnull View view, @Nonnull String cellID, @Nonnull String dashboardID)
      Add the view to a cell.
      Parameters:
      view - the view for a cell
      cellID - ID of cell to update
      dashboardID - ID of dashboard to update
      Returns:
      Added cell view

    • updateCellView

      @Nonnull View updateCellView(@Nonnull View view, @Nonnull Cell cell, @Nonnull Dashboard dashboard)
      Update the view for a cell.
      Parameters:
      view - updates the view for a cell
      cell - cell to update
      dashboard - dashboard to update
      Returns:
      Updated cell view

    • updateCellView

      @Nonnull View updateCellView(@Nonnull View view, @Nonnull String cellID, @Nonnull String dashboardID)
      Update the view for a cell.
      Parameters:
      view - updates the view for a cell
      cellID - ID of cell to update
      dashboardID - ID of dashboard to update
      Returns:
      Updated cell view

    • getCellView

      @Nonnull View getCellView(@Nonnull Cell cell, @Nonnull Dashboard dashboard)
      Retrieve the view for a cell in a dashboard.
      Parameters:
      cell - cell
      dashboard - dashboard
      Returns:
      A dashboard cells view

    • getCellView

      @Nonnull View getCellView(@Nonnull String cellID, @Nonnull String dashboardID)
      Retrieve the view for a cell in a dashboard.
      Parameters:
      cellID - ID of cell
      dashboardID - ID of dashboard
      Returns:
      A dashboard cells view