w.settings.sql_results_download: SQL Results Download

class databricks.sdk.service.settings.SqlResultsDownloadAPI

Controls whether users within the workspace are allowed to download results from the SQL Editor and AI/BI Dashboards UIs. By default, this setting is enabled (set to true)

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

Reverts the SQL Results Download 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:

DeleteSqlResultsDownloadResponse

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

Gets the SQL Results Download 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:

SqlResultsDownload

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

Updates the SQL Results Download setting.

Parameters:

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

  • setting – SqlResultsDownload

  • 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:

SqlResultsDownload