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.

**Warning**: This API is deprecated. Please use the AI/BI Dashboards API instead. [Learn more]

[Learn more]: https://docs.databricks.com/en/dashboards/

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
void	delete(DeleteDashboardRequest request) Moves a dashboard to the trash.
void	delete(String dashboardId)
Dashboard	get(GetDashboardRequest request) Returns a JSON representation of a dashboard object, including its visualization and query objects.
Dashboard	get(String dashboardId)
DashboardsService	impl()
Iterable<Dashboard>	list(ListDashboardsRequest request) Fetch a paginated list of dashboard objects.
void	restore(RestoreDashboardRequest request) A restored dashboard appears in list views and searches and can be shared.
Dashboard	update(DashboardEditContent request) Modify this dashboard definition.

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

delete

public void delete(String dashboardId)

delete

public void delete(DeleteDashboardRequest request)

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

**Warning**: This API is deprecated. Please use the AI/BI Dashboards API instead. [Learn more]

[Learn more]: https://docs.databricks.com/en/dashboards/

get

public Dashboard get(String dashboardId)

get

public Dashboard get(GetDashboardRequest request)

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

**Warning**: This API is deprecated. Please use the AI/BI Dashboards API instead. [Learn more]

[Learn more]: https://docs.databricks.com/en/dashboards/

list

public Iterable<Dashboard> list(ListDashboardsRequest request)

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.

**Warning**: This API is deprecated. Please use the AI/BI Dashboards API instead. [Learn more]

[Learn more]: https://docs.databricks.com/en/dashboards/

restore

public void restore(RestoreDashboardRequest request)

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

**Warning**: This API is deprecated. Please use the AI/BI Dashboards API instead. [Learn more]

[Learn more]: https://docs.databricks.com/en/dashboards/

update

public Dashboard update(DashboardEditContent request)

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.

**Warning**: This API is deprecated. Please use the AI/BI Dashboards API instead. [Learn more]

[Learn more]: https://docs.databricks.com/en/dashboards/

impl

public DashboardsService impl()