Class LakeviewClient

Constructors

constructor

new LakeviewClient(options: ClientOptions): LakeviewClient
Parameters
- options: ClientOptions
Returns LakeviewClient
- Defined in client.ts:90

Methods

createDashboard

createDashboard(
req: CreateDashboardRequest,
options?: CallOptions,
): Promise<Dashboard>
Create a draft dashboard.
Parameters
- req: CreateDashboardRequest
- Optionaloptions: CallOptions
Returns Promise<Dashboard>
- Defined in client.ts:106

createSchedule

createSchedule(
req: CreateScheduleRequest,
options?: CallOptions,
): Promise<Schedule>
Create dashboard schedule.
Parameters
- req: CreateScheduleRequest
- Optionaloptions: CallOptions
Returns Promise<Schedule>
- Defined in client.ts:151

createSubscription

createSubscription(
req: CreateSubscriptionRequest,
options?: CallOptions,
): Promise<Subscription>
Create schedule subscription.
Parameters
- req: CreateSubscriptionRequest
- Optionaloptions: CallOptions
Returns Promise<Subscription>
- Defined in client.ts:181

deleteSchedule

deleteSchedule(req: DeleteScheduleRequest, options?: CallOptions): Promise<void>
Delete dashboard schedule.
Parameters
- req: DeleteScheduleRequest
- Optionaloptions: CallOptions
Returns Promise<void>
- Defined in client.ts:211

deleteSubscription

deleteSubscription(
req: DeleteSubscriptionRequest,
options?: CallOptions,
): Promise<void>
Delete schedule subscription.
Parameters
- req: DeleteSubscriptionRequest
- Optionaloptions: CallOptions
Returns Promise<void>
- Defined in client.ts:240

getDashboard

getDashboard(
req: GetDashboardRequest,
options?: CallOptions,
): Promise<Dashboard>
Get a draft dashboard.
Parameters
- req: GetDashboardRequest
- Optionaloptions: CallOptions
Returns Promise<Dashboard>
- Defined in client.ts:269

getPublishedDashboard

getPublishedDashboard(
req: GetPublishedDashboardRequest,
options?: CallOptions,
): Promise<PublishedDashboard>
Get the current published dashboard.
Parameters
- req: GetPublishedDashboardRequest
- Optionaloptions: CallOptions
Returns Promise<PublishedDashboard>
- Defined in client.ts:298

getPublishedDashboardTokenInfo

getPublishedDashboardTokenInfo(
req: GetPublishedDashboardTokenInfoRequest,
options?: CallOptions,
): Promise<GetPublishedDashboardTokenInfoResponse>
Get a required authorization details and scopes of a published dashboard to mint an OAuth token.
Parameters
- req: GetPublishedDashboardTokenInfoRequest
- Optionaloptions: CallOptions
Returns Promise<GetPublishedDashboardTokenInfoResponse>
- Defined in client.ts:327

getSchedule

getSchedule(req: GetScheduleRequest, options?: CallOptions): Promise<Schedule>
Get dashboard schedule.
Parameters
- req: GetScheduleRequest
- Optionaloptions: CallOptions
Returns Promise<Schedule>
- Defined in client.ts:368

getSubscription

getSubscription(
req: GetSubscriptionRequest,
options?: CallOptions,
): Promise<Subscription>
Get schedule subscription.
Parameters
- req: GetSubscriptionRequest
- Optionaloptions: CallOptions
Returns Promise<Subscription>
- Defined in client.ts:397

listDashboards

listDashboards(
req: ListDashboardsRequest,
options?: CallOptions,
): Promise<ListDashboardsResponse>
List dashboards.
Parameters
- req: ListDashboardsRequest
- Optionaloptions: CallOptions
Returns Promise<ListDashboardsResponse>
- Defined in client.ts:426

listDashboardsIter

listDashboardsIter(
req: ListDashboardsRequest,
options?: CallOptions,
): AsyncGenerator<Dashboard>
Parameters
- req: ListDashboardsRequest
- Optionaloptions: CallOptions
Returns AsyncGenerator<Dashboard>
- Defined in client.ts:469

listSchedules

listSchedules(
req: ListSchedulesRequest,
options?: CallOptions,
): Promise<ListSchedulesResponse>
List dashboard schedules.
Parameters
- req: ListSchedulesRequest
- Optionaloptions: CallOptions
Returns Promise<ListSchedulesResponse>
- Defined in client.ts:487

listSchedulesIter

listSchedulesIter(
req: ListSchedulesRequest,
options?: CallOptions,
): AsyncGenerator<Schedule>
Parameters
- req: ListSchedulesRequest
- Optionaloptions: CallOptions
Returns AsyncGenerator<Schedule>
- Defined in client.ts:524

listSubscriptions

listSubscriptions(
req: ListSubscriptionsRequest,
options?: CallOptions,
): Promise<ListSubscriptionsResponse>
List schedule subscriptions.
Parameters
- req: ListSubscriptionsRequest
- Optionaloptions: CallOptions
Returns Promise<ListSubscriptionsResponse>
- Defined in client.ts:542

listSubscriptionsIter

listSubscriptionsIter(
req: ListSubscriptionsRequest,
options?: CallOptions,
): AsyncGenerator<Subscription>
Parameters
- req: ListSubscriptionsRequest
- Optionaloptions: CallOptions
Returns AsyncGenerator<Subscription>
- Defined in client.ts:579

migrateDashboard

migrateDashboard(
req: MigrateDashboardRequest,
options?: CallOptions,
): Promise<Dashboard>
Migrates a classic SQL dashboard to Lakeview.
Parameters
- req: MigrateDashboardRequest
- Optionaloptions: CallOptions
Returns Promise<Dashboard>
- Defined in client.ts:597

publishDashboard

publishDashboard(
req: PublishDashboardRequest,
options?: CallOptions,
): Promise<PublishedDashboard>
Publish the current draft dashboard.
Parameters
- req: PublishDashboardRequest
- Optionaloptions: CallOptions
Returns Promise<PublishedDashboard>
- Defined in client.ts:627

revertDashboard

revertDashboard(
req: RevertDashboardRequest,
options?: CallOptions,
): Promise<RevertDashboardResponse>
Revert a dashboard's definition in draft mode to the last published version.
Parameters
- req: RevertDashboardRequest
- Optionaloptions: CallOptions
Returns Promise<RevertDashboardResponse>
- Defined in client.ts:657

trashDashboard

trashDashboard(
req: TrashDashboardRequest,
options?: CallOptions,
): Promise<TrashDashboardResponse>
Trash a dashboard.
Parameters
- req: TrashDashboardRequest
- Optionaloptions: CallOptions
Returns Promise<TrashDashboardResponse>
- Defined in client.ts:687

unpublishDashboard

unpublishDashboard(
req: UnpublishDashboardRequest,
options?: CallOptions,
): Promise<UnpublishDashboardResponse>
Unpublish the dashboard.
Parameters
- req: UnpublishDashboardRequest
- Optionaloptions: CallOptions
Returns Promise<UnpublishDashboardResponse>
- Defined in client.ts:716

updateDashboard

updateDashboard(
req: UpdateDashboardRequest,
options?: CallOptions,
): Promise<Dashboard>
Update a draft dashboard.
Parameters
- req: UpdateDashboardRequest
- Optionaloptions: CallOptions
Returns Promise<Dashboard>
- Defined in client.ts:745

updateSchedule

updateSchedule(
req: UpdateScheduleRequest,
options?: CallOptions,
): Promise<Schedule>
Update dashboard schedule.
Parameters
- req: UpdateScheduleRequest
- Optionaloptions: CallOptions
Returns Promise<Schedule>
- Defined in client.ts:790