Package org.azd.dashboard.dashboards

Class DashboardsRequestBuilder

java.lang.Object
org.azd.abstractions.BaseRequestBuilder
org.azd.dashboard.dashboards.DashboardsRequestBuilder
public class DashboardsRequestBuilder extends BaseRequestBuilder
Provides functionality to work with Dashboard dashboards Api.

  • Constructor Details

    • DashboardsRequestBuilder

      public DashboardsRequestBuilder(String organizationUrl, AccessTokenCredential accessTokenCredential)
      Instantiates a new RequestBuilder instance and sets the default values.
      Parameters:
      organizationUrl - Represents organization location request url.
      accessTokenCredential - Access token credential object.

  • Method Details

    • createAsync

      public CompletableFuture<Dashboard> createAsync(String team, Dashboard dashboard) throws AzDException
      Create the supplied dashboard.
      Parameters:
      team - Team name or ID.
      dashboard - The initial state of the dashboard.
      Returns:
      Dashboard object Dashboard
      Throws:
      AzDException - Default Api Exception handler.

    • deleteAsync

      public CompletableFuture<Void> deleteAsync(String team, String dashboardId) throws AzDException
      Delete a dashboard given its ID. This also deletes the widgets associated with this dashboard.
      Parameters:
      team - Team name or ID.
      dashboardId - ID of the dashboard to delete.
      Throws:
      AzDException - Default Api Exception handler.

    • getAsync

      public CompletableFuture<Dashboard> getAsync(String team, String dashboardId) throws AzDException
      Get a dashboard by its ID.
      Parameters:
      team - Team name or ID.
      dashboardId - ID of the dashboard.
      Returns:
      Dashboard object Dashboard
      Throws:
      AzDException - Default Api Exception handler.

    • listAsync

      public CompletableFuture<DashboardList> listAsync(String team) throws AzDException
      Get a list of dashboards under a project for the specified team.
      Parameters:
      team - Team name or ID.
      Returns:
      DashboardList DashboardList
      Throws:
      AzDException - Default Api Exception handler.

    • replaceAsync

      public CompletableFuture<Dashboard> replaceAsync(String team, String dashboardId, Dashboard dashboard) throws AzDException
      Replace configuration for the specified dashboard. Replaces Widget list on Dashboard, only if property is supplied.
      Parameters:
      team - Team name or ID.
      dashboardId - ID of the dashboard to replace.
      dashboard - The configuration of the dashboard to replace.
      Returns:
      Dashboard object Dashboard
      Throws:
      AzDException - Default Api Exception handler.

    • replaceDashboardsAsync

      public CompletableFuture<DashboardGroup> replaceDashboardsAsync(String team, DashboardGroup group) throws AzDException
      Update the name and position of dashboards in the supplied group, and remove omitted dashboards. Does not modify dashboard content.
      Parameters:
      team - Team name or ID.
      group - Dashboard group.
      Returns:
      DashboardGroup object DashboardGroup
      Throws:
      AzDException - Default Api Exception handler.

    • create

      public Dashboard create(String team, Dashboard dashboard) throws AzDException
      Create the supplied dashboard.
      Parameters:
      team - Team name or ID.
      dashboard - The initial state of the dashboard.
      Returns:
      Dashboard object Dashboard
      Throws:
      AzDException - Default Api Exception handler.

    • delete

      public Void delete(String team, String dashboardId) throws AzDException
      Delete a dashboard given its ID. This also deletes the widgets associated with this dashboard.
      Parameters:
      team - Team name or ID.
      dashboardId - ID of the dashboard to delete.
      Throws:
      AzDException - Default Api Exception handler.

    • get

      public Dashboard get(String team, String dashboardId) throws AzDException
      Get a dashboard by its ID.
      Parameters:
      team - Team name or ID.
      dashboardId - ID of the dashboard.
      Returns:
      Dashboard object Dashboard
      Throws:
      AzDException - Default Api Exception handler.

    • list

      public DashboardList list(String team) throws AzDException
      Get a list of dashboards under a project for the specified team.
      Parameters:
      team - Team name or ID.
      Returns:
      DashboardList DashboardList
      Throws:
      AzDException - Default Api Exception handler.

    • replace

      public Dashboard replace(String team, String dashboardId, Dashboard dashboard) throws AzDException
      Replace configuration for the specified dashboard. Replaces Widget list on Dashboard, only if property is supplied.
      Parameters:
      team - Team name or ID.
      dashboardId - ID of the dashboard to replace.
      dashboard - The configuration of the dashboard to replace.
      Returns:
      Dashboard object Dashboard
      Throws:
      AzDException - Default Api Exception handler.

    • replaceDashboards

      public DashboardGroup replaceDashboards(String team, DashboardGroup group) throws AzDException
      Update the name and position of dashboards in the supplied group, and remove omitted dashboards. Does not modify dashboard content.
      Parameters:
      team - Team name or ID.
      group - Dashboard group.
      Returns:
      DashboardGroup object DashboardGroup
      Throws:
      AzDException - Default Api Exception handler.