Dashboards¶

These dataclasses are used in the SDK to represent API requests and responses for services in the databricks.sdk.service.dashboards module.

class databricks.sdk.service.dashboards.CreateDashboardRequest¶

display_name: str¶: The display name of the dashboard.

parent_path: str | None = None¶: The workspace path of the folder containing the dashboard. Includes leading slash and no trailing slash.

serialized_dashboard: str | None = None¶: The contents of the dashboard in serialized string form.

warehouse_id: str | None = None¶: The warehouse ID used to run the dashboard.

as_dict() → dict¶: Serializes the CreateDashboardRequest into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → CreateDashboardRequest¶: Deserializes the CreateDashboardRequest from a dictionary.

class databricks.sdk.service.dashboards.Dashboard¶

create_time: str | None = None¶: The timestamp of when the dashboard was created.

dashboard_id: str | None = None¶: UUID identifying the dashboard.

display_name: str | None = None¶: The display name of the dashboard.

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.

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.

path: str | None = None¶: The workspace path of the dashboard asset, including the file name.

serialized_dashboard: str | None = None¶: The contents of the dashboard in serialized string form.

update_time: str | None = None¶: The timestamp of when the dashboard was last updated by the user.

warehouse_id: str | None = None¶: The warehouse ID used to run the dashboard.

as_dict() → dict¶: Serializes the Dashboard into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → Dashboard¶: Deserializes the Dashboard from a dictionary.

class databricks.sdk.service.dashboards.LifecycleState¶

ACTIVE = "ACTIVE"¶

TRASHED = "TRASHED"¶

class databricks.sdk.service.dashboards.MigrateDashboardRequest¶

source_dashboard_id: str¶: UUID of the dashboard to be migrated.

display_name: str | None = None¶: Display name for the new Lakeview dashboard.

parent_path: str | None = None¶: The workspace path of the folder to contain the migrated Lakeview dashboard.

as_dict() → dict¶: Serializes the MigrateDashboardRequest into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → MigrateDashboardRequest¶: Deserializes the MigrateDashboardRequest from a dictionary.

class databricks.sdk.service.dashboards.PublishRequest¶

dashboard_id: str | None = None¶: UUID identifying the dashboard to be published.

embed_credentials: bool | None = None¶: Flag to indicate if the publisher’s credentials should be embedded in the published dashboard. These embedded credentials will be used to execute the published dashboard’s queries.

warehouse_id: str | None = None¶: The ID of the warehouse that can be used to override the warehouse which was set in the draft.

as_dict() → dict¶: Serializes the PublishRequest into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → PublishRequest¶: Deserializes the PublishRequest from a dictionary.

class databricks.sdk.service.dashboards.PublishedDashboard¶

display_name: str | None = None¶: The display name of the published dashboard.

embed_credentials: bool | None = None¶: Indicates whether credentials are embedded in the published dashboard.

revision_create_time: str | None = None¶: The timestamp of when the published dashboard was last revised.

warehouse_id: str | None = None¶: The warehouse ID used to run the published dashboard.

as_dict() → dict¶: Serializes the PublishedDashboard into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → PublishedDashboard¶: Deserializes the PublishedDashboard from a dictionary.

class databricks.sdk.service.dashboards.TrashDashboardResponse¶

as_dict() → dict¶: Serializes the TrashDashboardResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → TrashDashboardResponse¶: Deserializes the TrashDashboardResponse from a dictionary.

class databricks.sdk.service.dashboards.UnpublishDashboardResponse¶

as_dict() → dict¶: Serializes the UnpublishDashboardResponse into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → UnpublishDashboardResponse¶: Deserializes the UnpublishDashboardResponse from a dictionary.

class databricks.sdk.service.dashboards.UpdateDashboardRequest¶

dashboard_id: str | None = None¶: UUID identifying the dashboard.

display_name: str | None = None¶: The display name of the dashboard.

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.

serialized_dashboard: str | None = None¶: The contents of the dashboard in serialized string form.

warehouse_id: str | None = None¶: The warehouse ID used to run the dashboard.

as_dict() → dict¶: Serializes the UpdateDashboardRequest into a dictionary suitable for use as a JSON request body.

classmethod from_dict(d: Dict[str, any]) → UpdateDashboardRequest¶: Deserializes the UpdateDashboardRequest from a dictionary.