Databricks SDK for JavaScript
    Preparing search index...

    Interface Dashboard

    interface Dashboard {
        createTime?: Instant;
        dashboardId?: string;
        displayName?: string;
        etag?: string;
        lifecycleState?: LifecycleState;
        parentPath?: string;
        path?: string;
        serializedDashboard?: string;
        updateTime?: Instant;
        warehouseId?: string;
    }
    Index

    Properties

    createTime? dashboardId? displayName? etag? lifecycleState? parentPath? path? serializedDashboard? updateTime? warehouseId?

    Properties

    createTime?: Instant

    The timestamp of when the dashboard was created.

    dashboardId?: string

    UUID identifying the dashboard.

    displayName?: string

    The display name of the dashboard.

    etag?: string

    The etag for the dashboard. Can be optionally provided on updates to ensure that the dashboard has not been modified since the last read. This field is excluded in List Dashboards responses.

    lifecycleState?: LifecycleState

    The state of the dashboard resource. Used for tracking trashed status.

    parentPath?: string

    The workspace path of the folder containing the dashboard. Includes leading slash and no trailing slash. This field is excluded in List Dashboards responses.

    path?: string

    The workspace path of the dashboard asset, including the file name. Exported dashboards always have the file extension .lvdash.json. This field is excluded in List Dashboards responses.

    serializedDashboard?: string

    The contents of the dashboard in serialized string form. This field is excluded in List Dashboards responses. Use the get dashboard API to retrieve an example response, which includes the serialized_dashboard field. This field provides the structure of the JSON string that represents the dashboard's layout and components.

    updateTime?: Instant

    The timestamp of when the dashboard was last updated by the user. This field is excluded in List Dashboards responses.

    warehouseId?: string

    The warehouse ID used to run the dashboard.

    Settings

    Member Visibility

    On This Page

    Properties