com.databricks.sdk.service.dashboards

Class LakeviewEmbeddedAPI

java.lang.Object

com.databricks.sdk.service.dashboards.LakeviewEmbeddedAPI

@Generated
public class LakeviewEmbeddedAPI
extends Object

Token-based Lakeview APIs for embedding dashboards in external applications.

Constructor Summary

Constructors

Constructor and Description
LakeviewEmbeddedAPI(ApiClient apiClient) Regular-use constructor
LakeviewEmbeddedAPI(LakeviewEmbeddedService mock) Constructor for mocks

Method Summary

Modifier and Type	Method and Description
void	getPublishedDashboardEmbedded(GetPublishedDashboardEmbeddedRequest request) Read a published dashboard in an embedded ui.
void	getPublishedDashboardEmbedded(String dashboardId)
GetPublishedDashboardTokenInfoResponse	getPublishedDashboardTokenInfo(GetPublishedDashboardTokenInfoRequest request) Read an information of a published dashboard to mint an OAuth token.
GetPublishedDashboardTokenInfoResponse	getPublishedDashboardTokenInfo(String dashboardId)
LakeviewEmbeddedService	impl()

Methods inherited from class java.lang.Object

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

Constructor Detail

LakeviewEmbeddedAPI

public LakeviewEmbeddedAPI(ApiClient apiClient)

Regular-use constructor

LakeviewEmbeddedAPI

public LakeviewEmbeddedAPI(LakeviewEmbeddedService mock)

Constructor for mocks

Method Detail

getPublishedDashboardEmbedded

public void getPublishedDashboardEmbedded(String dashboardId)

getPublishedDashboardEmbedded

public void getPublishedDashboardEmbedded(GetPublishedDashboardEmbeddedRequest request)

Read a published dashboard in an embedded ui.

Get the current published dashboard within an embedded context.

getPublishedDashboardTokenInfo

public GetPublishedDashboardTokenInfoResponse getPublishedDashboardTokenInfo(String dashboardId)

getPublishedDashboardTokenInfo

public GetPublishedDashboardTokenInfoResponse getPublishedDashboardTokenInfo(GetPublishedDashboardTokenInfoRequest request)

Read an information of a published dashboard to mint an OAuth token.

Get a required authorization details and scopes of a published dashboard to mint an OAuth token. The `authorization_details` can be enriched to apply additional restriction.

Example: Adding the following `authorization_details` object to downscope the viewer permission to specific table ``` { type: "unity_catalog_privileges", privileges: ["SELECT"], object_type: "TABLE", object_full_path: "main.default.testdata" } ```

impl

public LakeviewEmbeddedService impl()