com.databricks.sdk.service.dashboards

Class LakeviewAPI

java.lang.Object

com.databricks.sdk.service.dashboards.LakeviewAPI

@Generated
public class LakeviewAPI
extends Object

These APIs provide specific management operations for Lakeview dashboards. Generic resource management can be done with Workspace API (import, export, get-status, list, delete).

Constructor Summary

Constructors

Constructor and Description
LakeviewAPI(ApiClient apiClient) Regular-use constructor
LakeviewAPI(LakeviewService mock) Constructor for mocks

Method Summary

Modifier and Type	Method and Description
Dashboard	create(CreateDashboardRequest request) Create dashboard.
Dashboard	create(Dashboard dashboard)
Schedule	createSchedule(CreateScheduleRequest request) Create dashboard schedule.
Schedule	createSchedule(String dashboardId, Schedule schedule)
Subscription	createSubscription(CreateSubscriptionRequest request) Create schedule subscription.
Subscription	createSubscription(String dashboardId, String scheduleId, Subscription subscription)
void	deleteSchedule(DeleteScheduleRequest request) Delete dashboard schedule.
void	deleteSchedule(String dashboardId, String scheduleId)
void	deleteSubscription(DeleteSubscriptionRequest request) Delete schedule subscription.
void	deleteSubscription(String dashboardId, String scheduleId, String subscriptionId)
Dashboard	get(GetDashboardRequest request) Get dashboard.
Dashboard	get(String dashboardId)
PublishedDashboard	getPublished(GetPublishedDashboardRequest request) Get published dashboard.
PublishedDashboard	getPublished(String dashboardId)
Schedule	getSchedule(GetScheduleRequest request) Get dashboard schedule.
Schedule	getSchedule(String dashboardId, String scheduleId)
Subscription	getSubscription(GetSubscriptionRequest request) Get schedule subscription.
Subscription	getSubscription(String dashboardId, String scheduleId, String subscriptionId)
LakeviewService	impl()
Iterable<Dashboard>	list(ListDashboardsRequest request) List dashboards.
Iterable<Schedule>	listSchedules(ListSchedulesRequest request) List dashboard schedules.
Iterable<Schedule>	listSchedules(String dashboardId)
Iterable<Subscription>	listSubscriptions(ListSubscriptionsRequest request) List schedule subscriptions.
Iterable<Subscription>	listSubscriptions(String dashboardId, String scheduleId)
Dashboard	migrate(MigrateDashboardRequest request) Migrate dashboard.
Dashboard	migrate(String sourceDashboardId)
PublishedDashboard	publish(PublishRequest request) Publish dashboard.
PublishedDashboard	publish(String dashboardId)
void	trash(String dashboardId)
void	trash(TrashDashboardRequest request) Trash dashboard.
void	unpublish(String dashboardId)
void	unpublish(UnpublishDashboardRequest request) Unpublish dashboard.
Dashboard	update(String dashboardId, Dashboard dashboard)
Dashboard	update(UpdateDashboardRequest request) Update dashboard.
Schedule	updateSchedule(String dashboardId, String scheduleId, Schedule schedule)
Schedule	updateSchedule(UpdateScheduleRequest request) Update dashboard schedule.

Methods inherited from class java.lang.Object

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

Constructor Detail

LakeviewAPI

public LakeviewAPI(ApiClient apiClient)

Regular-use constructor

LakeviewAPI

public LakeviewAPI(LakeviewService mock)

Constructor for mocks

Method Detail

create

public Dashboard create(Dashboard dashboard)

create

public Dashboard create(CreateDashboardRequest request)

Create dashboard.

Create a draft dashboard.

createSchedule

public Schedule createSchedule(String dashboardId,
                               Schedule schedule)

createSchedule

public Schedule createSchedule(CreateScheduleRequest request)

Create dashboard schedule.

createSubscription

public Subscription createSubscription(String dashboardId,
                                       String scheduleId,
                                       Subscription subscription)

createSubscription

public Subscription createSubscription(CreateSubscriptionRequest request)

Create schedule subscription.

deleteSchedule

public void deleteSchedule(String dashboardId,
                           String scheduleId)

deleteSchedule

public void deleteSchedule(DeleteScheduleRequest request)

Delete dashboard schedule.

deleteSubscription

public void deleteSubscription(String dashboardId,
                               String scheduleId,
                               String subscriptionId)

deleteSubscription

public void deleteSubscription(DeleteSubscriptionRequest request)

Delete schedule subscription.

get

public Dashboard get(String dashboardId)

get

public Dashboard get(GetDashboardRequest request)

Get dashboard.

Get a draft dashboard.

getPublished

public PublishedDashboard getPublished(String dashboardId)

getPublished

public PublishedDashboard getPublished(GetPublishedDashboardRequest request)

Get published dashboard.

Get the current published dashboard.

getSchedule

public Schedule getSchedule(String dashboardId,
                            String scheduleId)

getSchedule

public Schedule getSchedule(GetScheduleRequest request)

Get dashboard schedule.

getSubscription

public Subscription getSubscription(String dashboardId,
                                    String scheduleId,
                                    String subscriptionId)

getSubscription

public Subscription getSubscription(GetSubscriptionRequest request)

Get schedule subscription.

list

public Iterable<Dashboard> list(ListDashboardsRequest request)

List dashboards.

listSchedules

public Iterable<Schedule> listSchedules(String dashboardId)

listSchedules

public Iterable<Schedule> listSchedules(ListSchedulesRequest request)

List dashboard schedules.

listSubscriptions

public Iterable<Subscription> listSubscriptions(String dashboardId,
                                                String scheduleId)

listSubscriptions

public Iterable<Subscription> listSubscriptions(ListSubscriptionsRequest request)

List schedule subscriptions.

migrate

public Dashboard migrate(String sourceDashboardId)

migrate

public Dashboard migrate(MigrateDashboardRequest request)

Migrate dashboard.

Migrates a classic SQL dashboard to Lakeview.

publish

public PublishedDashboard publish(String dashboardId)

publish

public PublishedDashboard publish(PublishRequest request)

Publish dashboard.

Publish the current draft dashboard.

trash

public void trash(String dashboardId)

trash

public void trash(TrashDashboardRequest request)

Trash dashboard.

Trash a dashboard.

unpublish

public void unpublish(String dashboardId)

unpublish

public void unpublish(UnpublishDashboardRequest request)

Unpublish dashboard.

Unpublish the dashboard.

update

public Dashboard update(String dashboardId,
                        Dashboard dashboard)

update

public Dashboard update(UpdateDashboardRequest request)

Update dashboard.

Update a draft dashboard.

updateSchedule

public Schedule updateSchedule(String dashboardId,
                               String scheduleId,
                               Schedule schedule)

updateSchedule

public Schedule updateSchedule(UpdateScheduleRequest request)

Update dashboard schedule.

impl

public LakeviewService impl()