com.cloudera.api.v6

Interface DashboardsResource

public interface DashboardsResource

Method Summary

Methods

Modifier and Type	Method and Description
ApiDashboardList	createDashboards(ApiDashboardList list) Creates the list of dashboards.
ApiDashboard	deleteDashboard(String dashboardName) Deletes a dashboard.
ApiDashboard	getDashboard(String dashboardName) Returns a dashboard definition for the specified name.
ApiDashboardList	getDashboards() Returns the list of all user-customized dashboards.

Method Detail

getDashboards

@Path(value="/")
ApiDashboardList getDashboards()

Returns the list of all user-customized dashboards. This includes both the new dashboards created by users as well as any user customizations to built-in dashboards.

Available since API v6.

createDashboards

@Path(value="/")
ApiDashboardList createDashboards(ApiDashboardList list)

Creates the list of dashboards. If any of the dashboards already exist this whole command will fail and no dashboards will be created.

Available since API v6.

Parameters:

list - The list of dashboards to create.

Returns:

The dashboards created.

getDashboard

@Path(value="/{dashboardName}")
ApiDashboard getDashboard(String dashboardName)

Returns a dashboard definition for the specified name. This dashboard can be imported with the createDashboards API.

Available since API v6.

Parameters:

dashboardName - The name of the dashboard.

deleteDashboard

@Path(value="/{dashboardName}")
ApiDashboard deleteDashboard(String dashboardName)

Deletes a dashboard.

Available since API v6.

Parameters:

dashboardName - The name of the dashboard.

Returns:

The deleted dashboard.