com.databricks.sdk.service.sql

Class DashboardsAPI

java.lang.Object

com.databricks.sdk.service.sql.DashboardsAPI

@Generated
public class DashboardsAPI
extends Object

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.

Constructor Summary

Constructors

Constructor and Description
DashboardsAPI(ApiClient apiClient) Regular-use constructor
DashboardsAPI(DashboardsService mock) Constructor for mocks

Method Summary

Modifier and Type	Method and Description
Dashboard	create(DashboardPostContent request) Create a dashboard object.
Dashboard	create(String name)
void	delete(DeleteDashboardRequest request) Remove a dashboard.
void	delete(String dashboardId)
Dashboard	get(GetDashboardRequest request) Retrieve a definition.
Dashboard	get(String dashboardId)
DashboardsService	impl()
Iterable<Dashboard>	list(ListDashboardsRequest request) Get dashboard objects.
void	restore(RestoreDashboardRequest request) Restore a dashboard.
void	restore(String dashboardId)
Dashboard	update(DashboardEditContent request) Change a dashboard definition.
Dashboard	update(String dashboardId)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DashboardsAPI

public DashboardsAPI(ApiClient apiClient)

Regular-use constructor

DashboardsAPI

public DashboardsAPI(DashboardsService mock)

Constructor for mocks

Method Detail

create

public Dashboard create(String name)

create

public Dashboard create(DashboardPostContent request)

Create a dashboard object.

delete

public void delete(String dashboardId)

delete

public void delete(DeleteDashboardRequest request)

Remove a dashboard.

Moves a dashboard to the trash. Trashed dashboards do not appear in list views or searches, and cannot be shared.

get

public Dashboard get(String dashboardId)

get

public Dashboard get(GetDashboardRequest request)

Retrieve a definition.

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

list

public Iterable<Dashboard> list(ListDashboardsRequest request)

Get dashboard objects.

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

public void restore(String dashboardId)

restore

public void restore(RestoreDashboardRequest request)

Restore a dashboard.

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

update

public Dashboard update(String dashboardId)

update

public Dashboard update(DashboardEditContent request)

Change a dashboard definition.

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.

impl

public DashboardsService impl()