com.databricks.sdk.service.sql

Class DashboardWidgetsAPI

java.lang.Object

com.databricks.sdk.service.sql.DashboardWidgetsAPI

@Generated
public class DashboardWidgetsAPI
extends Object

This is an evolving API that facilitates the addition and removal of widgets from existing dashboards within the Databricks Workspace. Data structures may change over time.

Constructor Summary

Constructors

Constructor and Description
DashboardWidgetsAPI(ApiClient apiClient) Regular-use constructor
DashboardWidgetsAPI(DashboardWidgetsService mock) Constructor for mocks

Method Summary

Modifier and Type	Method and Description
Widget	create(CreateWidget request) Add widget to a dashboard.
Widget	create(String dashboardId, WidgetOptions options, long width)
void	delete(DeleteDashboardWidgetRequest request) Remove widget.
void	delete(String id)
DashboardWidgetsService	impl()
Widget	update(CreateWidget request) Update existing widget.
Widget	update(String id, String dashboardId, WidgetOptions options, long width)

Methods inherited from class java.lang.Object

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

Constructor Detail

DashboardWidgetsAPI

public DashboardWidgetsAPI(ApiClient apiClient)

Regular-use constructor

DashboardWidgetsAPI

public DashboardWidgetsAPI(DashboardWidgetsService mock)

Constructor for mocks

Method Detail

create

public Widget create(String dashboardId,
                     WidgetOptions options,
                     long width)

create

public Widget create(CreateWidget request)

Add widget to a dashboard.

delete

public void delete(String id)

delete

public void delete(DeleteDashboardWidgetRequest request)

Remove widget.

update

public Widget update(String id,
                     String dashboardId,
                     WidgetOptions options,
                     long width)

update

public Widget update(CreateWidget request)

Update existing widget.

impl

public DashboardWidgetsService impl()