Package com.databricks.sdk.service.sql
Interface DashboardsService
-
@Generated public interface DashboardsService
In general, there is little need to modify dashboards using the API. However, it can be useful to use dashboard objects to look-up a collection of related query IDs. The API can also be used to duplicate multiple dashboards at once since you can get a dashboard definition with a GET request and then POST it to create a new one.This is the high-level interface, that contains generated methods.
Evolving: this interface is under development. Method signatures may change.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description Dashboard
create(CreateDashboardRequest createDashboardRequest)
Create a dashboard object.void
delete(DeleteDashboardRequest deleteDashboardRequest)
Remove a dashboard.Dashboard
get(GetDashboardRequest getDashboardRequest)
Retrieve a definition.ListResponse
list(ListDashboardsRequest listDashboardsRequest)
Get dashboard objects.void
restore(RestoreDashboardRequest restoreDashboardRequest)
Restore a dashboard.
-
-
-
Method Detail
-
create
Dashboard create(CreateDashboardRequest createDashboardRequest)
Create a dashboard object.
-
delete
void delete(DeleteDashboardRequest deleteDashboardRequest)
Remove a dashboard.Moves a dashboard to the trash. Trashed dashboards do not appear in list views or searches, and cannot be shared.
-
get
Dashboard get(GetDashboardRequest getDashboardRequest)
Retrieve a definition.Returns a JSON representation of a dashboard object, including its visualization and query objects.
-
list
ListResponse list(ListDashboardsRequest listDashboardsRequest)
Get dashboard objects.Fetch a paginated list of dashboard objects.
-
restore
void restore(RestoreDashboardRequest restoreDashboardRequest)
Restore a dashboard.A restored dashboard appears in list views and searches and can be shared.
-
-