w.settings.dashboard_email_subscriptions: Dashboard Email Subscriptions

class databricks.sdk.service.settings.DashboardEmailSubscriptionsAPI

Controls whether schedules or workload tasks for refreshing AI/BI Dashboards in the workspace can send subscription emails containing PDFs and/or images of the dashboard. By default, this setting is enabled (set to true)

delete([, etag: Optional[str]]) → DeleteDashboardEmailSubscriptionsResponse

Reverts the Dashboard Email Subscriptions setting to its default value.

Parameters:

etag – str (optional) etag used for versioning. The response is at least as fresh as the eTag provided. This is used for optimistic concurrency control as a way to help prevent simultaneous writes of a setting overwriting each other. It is strongly suggested that systems make use of the etag in the read -> delete pattern to perform setting deletions in order to avoid race conditions. That is, get an etag from a GET request, and pass it with the DELETE request to identify the rule set version you are deleting.

Returns:

DeleteDashboardEmailSubscriptionsResponse

get([, etag: Optional[str]]) → DashboardEmailSubscriptions

Gets the Dashboard Email Subscriptions setting.

Parameters:

etag – str (optional) etag used for versioning. The response is at least as fresh as the eTag provided. This is used for optimistic concurrency control as a way to help prevent simultaneous writes of a setting overwriting each other. It is strongly suggested that systems make use of the etag in the read -> delete pattern to perform setting deletions in order to avoid race conditions. That is, get an etag from a GET request, and pass it with the DELETE request to identify the rule set version you are deleting.

Returns:

DashboardEmailSubscriptions

update(allow_missing: bool, setting: DashboardEmailSubscriptions, field_mask: str) → DashboardEmailSubscriptions

Updates the Dashboard Email Subscriptions setting.

Parameters:

  • allow_missing – bool This should always be set to true for Settings API. Added for AIP compliance.

  • setting – DashboardEmailSubscriptions

  • field_mask –

    str The field mask must be a single string, with multiple fields separated by commas (no spaces). The field path is relative to the resource object, using a dot (.) to navigate sub-fields (e.g., author.given_name). Specification of elements in sequence or map fields is not allowed, as only the entire collection field can be specified. Field names must exactly match the resource field names.

    A field mask of * indicates full replacement. It’s recommended to always explicitly list the fields being updated and avoid using * wildcards, as it can lead to unintended results if the API changes in the future.

Returns:

DashboardEmailSubscriptions