com.databricks.sdk.service.dashboards

Interface LakeviewService

@Generated
public interface LakeviewService

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

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
Dashboard	create(CreateDashboardRequest createDashboardRequest) Create a draft dashboard.
Schedule	createSchedule(CreateScheduleRequest createScheduleRequest) Create dashboard schedule.
Subscription	createSubscription(CreateSubscriptionRequest createSubscriptionRequest) Create schedule subscription.
void	deleteSchedule(DeleteScheduleRequest deleteScheduleRequest) Delete dashboard schedule.
void	deleteSubscription(DeleteSubscriptionRequest deleteSubscriptionRequest) Delete schedule subscription.
Dashboard	get(GetDashboardRequest getDashboardRequest) Get a draft dashboard.
PublishedDashboard	getPublished(GetPublishedDashboardRequest getPublishedDashboardRequest) Get the current published dashboard.
Schedule	getSchedule(GetScheduleRequest getScheduleRequest) Get dashboard schedule.
Subscription	getSubscription(GetSubscriptionRequest getSubscriptionRequest) Get schedule subscription.
ListDashboardsResponse	list(ListDashboardsRequest listDashboardsRequest) List dashboards.
ListSchedulesResponse	listSchedules(ListSchedulesRequest listSchedulesRequest) List dashboard schedules.
ListSubscriptionsResponse	listSubscriptions(ListSubscriptionsRequest listSubscriptionsRequest) List schedule subscriptions.
Dashboard	migrate(MigrateDashboardRequest migrateDashboardRequest) Migrates a classic SQL dashboard to Lakeview.
PublishedDashboard	publish(PublishRequest publishRequest) Publish the current draft dashboard.
void	trash(TrashDashboardRequest trashDashboardRequest) Trash a dashboard.
void	unpublish(UnpublishDashboardRequest unpublishDashboardRequest) Unpublish the dashboard.
Dashboard	update(UpdateDashboardRequest updateDashboardRequest) Update a draft dashboard.
Schedule	updateSchedule(UpdateScheduleRequest updateScheduleRequest) Update dashboard schedule.

Method Detail

create

Dashboard create(CreateDashboardRequest createDashboardRequest)

Create a draft dashboard.

createSchedule

Schedule createSchedule(CreateScheduleRequest createScheduleRequest)

Create dashboard schedule.

createSubscription

Subscription createSubscription(CreateSubscriptionRequest createSubscriptionRequest)

Create schedule subscription.

deleteSchedule

void deleteSchedule(DeleteScheduleRequest deleteScheduleRequest)

Delete dashboard schedule.

deleteSubscription

void deleteSubscription(DeleteSubscriptionRequest deleteSubscriptionRequest)

Delete schedule subscription.

get

Dashboard get(GetDashboardRequest getDashboardRequest)

Get a draft dashboard.

getPublished

PublishedDashboard getPublished(GetPublishedDashboardRequest getPublishedDashboardRequest)

Get the current published dashboard.

getSchedule

Schedule getSchedule(GetScheduleRequest getScheduleRequest)

Get dashboard schedule.

getSubscription

Subscription getSubscription(GetSubscriptionRequest getSubscriptionRequest)

Get schedule subscription.

list

ListDashboardsResponse list(ListDashboardsRequest listDashboardsRequest)

List dashboards.

listSchedules

ListSchedulesResponse listSchedules(ListSchedulesRequest listSchedulesRequest)

List dashboard schedules.

listSubscriptions

ListSubscriptionsResponse listSubscriptions(ListSubscriptionsRequest listSubscriptionsRequest)

List schedule subscriptions.

migrate

Dashboard migrate(MigrateDashboardRequest migrateDashboardRequest)

Migrates a classic SQL dashboard to Lakeview.

publish

PublishedDashboard publish(PublishRequest publishRequest)

Publish the current draft dashboard.

trash

void trash(TrashDashboardRequest trashDashboardRequest)

Trash a dashboard.

unpublish

void unpublish(UnpublishDashboardRequest unpublishDashboardRequest)

Unpublish the dashboard.

update

Dashboard update(UpdateDashboardRequest updateDashboardRequest)

Update a draft dashboard.

updateSchedule

Schedule updateSchedule(UpdateScheduleRequest updateScheduleRequest)

Update dashboard schedule.