Dashboards

Package: databricks.bundles.dashboards

Classes

class Dashboard

create_time: str | None = None

The timestamp of when the dashboard was created.

dashboard_id: str | None = None

UUID identifying the dashboard.

dataset_catalog: str | None = None

Sets the default catalog for all datasets in this dashboard. When set, this overrides the catalog specified in individual dataset definitions.

dataset_schema: str | None = None

Sets the default schema for all datasets in this dashboard. When set, this overrides the schema specified in individual dataset definitions.

display_name: str | None = None

The display name of the dashboard.

embed_credentials: bool | None = None

etag: str | None = None

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.

file_path: str | None = None

lifecycle: Lifecycle | None = None

Settings that control the deployment lifecycle of the resource, such as preventing it from being destroyed.

lifecycle_state: LifecycleState | None = None

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

parent_path: str | None = None

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: str | None = None

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.

permissions: list[Permission]

The permissions to apply to this resource.

serialized_dashboard: Any | None = None

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.

update_time: str | None = None

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

warehouse_id: str | None = None

The warehouse ID used to run the dashboard.

classmethod from_dict(

value: dict,

) → Self

as_dict(

self,

) → dict

class Lifecycle

prevent_destroy: bool | None = None

Lifecycle setting to prevent the resource from being destroyed.

classmethod from_dict(

value: dict,

) → Self

as_dict(

self,

) → dict

class LifecycleState

ACTIVE = 'ACTIVE'

TRASHED = 'TRASHED'

class Permission

level: PermissionLevel

The permission level to apply. The allowed levels depend on the resource type.

group_name: str | None = None

The name of the group granted the permission level.

service_principal_name: str | None = None

The name of the service principal granted the permission level.

user_name: str | None = None

The name of the user granted the permission level.

classmethod from_dict(

value: dict,

) → Self

as_dict(

self,

) → dict

class PermissionLevel

Permission level

CAN_MANAGE = 'CAN_MANAGE'

CAN_RESTART = 'CAN_RESTART'

CAN_ATTACH_TO = 'CAN_ATTACH_TO'

IS_OWNER = 'IS_OWNER'

CAN_MANAGE_RUN = 'CAN_MANAGE_RUN'

CAN_VIEW = 'CAN_VIEW'

CAN_READ = 'CAN_READ'

CAN_RUN = 'CAN_RUN'

CAN_EDIT = 'CAN_EDIT'

CAN_USE = 'CAN_USE'

CAN_MANAGE_STAGING_VERSIONS = 'CAN_MANAGE_STAGING_VERSIONS'

CAN_MANAGE_PRODUCTION_VERSIONS = 'CAN_MANAGE_PRODUCTION_VERSIONS'

CAN_EDIT_METADATA = 'CAN_EDIT_METADATA'

CAN_VIEW_METADATA = 'CAN_VIEW_METADATA'

CAN_BIND = 'CAN_BIND'

CAN_QUERY = 'CAN_QUERY'

CAN_MONITOR = 'CAN_MONITOR'

CAN_CREATE = 'CAN_CREATE'

CAN_MONITOR_ONLY = 'CAN_MONITOR_ONLY'

CAN_CREATE_APP = 'CAN_CREATE_APP'