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. Dashboards can be scheduled using the `sql_task` type of the Jobs API, e.g. :method:jobs/create.

This is the high-level interface, that contains generated methods.

Evolving: this interface is under development. Method signatures may change.

Method Summary

Modifier and Type	Method and Description
void	delete(DeleteDashboardRequest deleteDashboardRequest) Moves a dashboard to the trash.
Dashboard	get(GetDashboardRequest getDashboardRequest) Returns a JSON representation of a dashboard object, including its visualization and query objects.
ListResponse	list(ListDashboardsRequest listDashboardsRequest) Fetch a paginated list of dashboard objects.
void	restore(RestoreDashboardRequest restoreDashboardRequest) A restored dashboard appears in list views and searches and can be shared.
Dashboard	update(DashboardEditContent dashboardEditContent) Modify this dashboard definition.

Method Detail

delete

void delete(DeleteDashboardRequest deleteDashboardRequest)

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)

Returns a JSON representation of a dashboard object, including its visualization and query objects.

list

ListResponse list(ListDashboardsRequest listDashboardsRequest)

Fetch a paginated list of dashboard objects.

**Warning**: Calling this API concurrently 10 or more times could result in throttling, service degradation, or a temporary ban.

restore

void restore(RestoreDashboardRequest restoreDashboardRequest)

A restored dashboard appears in list views and searches and can be shared.

update

Dashboard update(DashboardEditContent dashboardEditContent)

Modify this dashboard definition. This operation only affects attributes of the dashboard object. It does not add, modify, or remove widgets.

**Note**: You cannot undo this operation.