com.databricks.sdk.service.settings

Class SettingsAPI

java.lang.Object

com.databricks.sdk.service.settings.SettingsAPI

@Generated
public class SettingsAPI
extends Object

The default namespace setting API allows users to configure the default namespace for a Databricks workspace.

Through this API, users can retrieve, set, or modify the default namespace used when queries do not reference a fully qualified three-level name. For example, if you use the API to set 'retail_prod' as the default catalog, then a query 'SELECT * FROM myTable' would reference the object 'retail_prod.default.myTable' (the schema 'default' is always assumed).

This setting requires a restart of clusters and SQL warehouses to take effect. Additionally, the default namespace only applies when using Unity Catalog-enabled compute.

Constructor Summary

Constructors

Constructor and Description
SettingsAPI(ApiClient apiClient) Regular-use constructor
SettingsAPI(SettingsService mock) Constructor for mocks

Method Summary

Modifier and Type	Method and Description
DeleteDefaultNamespaceSettingResponse	deleteDefaultNamespaceSetting(DeleteDefaultNamespaceSettingRequest request) Delete the default namespace setting.
DeleteRestrictWorkspaceAdminsSettingResponse	deleteRestrictWorkspaceAdminsSetting(DeleteRestrictWorkspaceAdminsSettingRequest request) Delete the restrict workspace admins setting.
DefaultNamespaceSetting	getDefaultNamespaceSetting(GetDefaultNamespaceSettingRequest request) Get the default namespace setting.
RestrictWorkspaceAdminsSetting	getRestrictWorkspaceAdminsSetting(GetRestrictWorkspaceAdminsSettingRequest request) Get the restrict workspace admins setting.
SettingsService	impl()
DefaultNamespaceSetting	updateDefaultNamespaceSetting(boolean allowMissing, DefaultNamespaceSetting setting, String fieldMask)
DefaultNamespaceSetting	updateDefaultNamespaceSetting(UpdateDefaultNamespaceSettingRequest request) Update the default namespace setting.
RestrictWorkspaceAdminsSetting	updateRestrictWorkspaceAdminsSetting(boolean allowMissing, RestrictWorkspaceAdminsSetting setting, String fieldMask)
RestrictWorkspaceAdminsSetting	updateRestrictWorkspaceAdminsSetting(UpdateRestrictWorkspaceAdminsSettingRequest request) Update the restrict workspace admins setting.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SettingsAPI

public SettingsAPI(ApiClient apiClient)

Regular-use constructor

SettingsAPI

public SettingsAPI(SettingsService mock)

Constructor for mocks

Method Detail

deleteDefaultNamespaceSetting

public DeleteDefaultNamespaceSettingResponse deleteDefaultNamespaceSetting(DeleteDefaultNamespaceSettingRequest request)

Delete the default namespace setting.

Deletes the default namespace setting for the workspace. A fresh etag needs to be provided in DELETE requests (as a query parameter). The etag can be retrieved by making a GET request before the DELETE request. If the setting is updated/deleted concurrently, DELETE will fail with 409 and the request will need to be retried by using the fresh etag in the 409 response.

deleteRestrictWorkspaceAdminsSetting

public DeleteRestrictWorkspaceAdminsSettingResponse deleteRestrictWorkspaceAdminsSetting(DeleteRestrictWorkspaceAdminsSettingRequest request)

Delete the restrict workspace admins setting.

Reverts the restrict workspace admins setting status for the workspace. A fresh etag needs to be provided in DELETE requests (as a query parameter). The etag can be retrieved by making a GET request before the DELETE request. If the setting is updated/deleted concurrently, DELETE will fail with 409 and the request will need to be retried by using the fresh etag in the 409 response.

getDefaultNamespaceSetting

public DefaultNamespaceSetting getDefaultNamespaceSetting(GetDefaultNamespaceSettingRequest request)

Get the default namespace setting.

Gets the default namespace setting.

getRestrictWorkspaceAdminsSetting

public RestrictWorkspaceAdminsSetting getRestrictWorkspaceAdminsSetting(GetRestrictWorkspaceAdminsSettingRequest request)

Get the restrict workspace admins setting.

Gets the restrict workspace admins setting.

updateDefaultNamespaceSetting

public DefaultNamespaceSetting updateDefaultNamespaceSetting(boolean allowMissing,
                                                             DefaultNamespaceSetting setting,
                                                             String fieldMask)

updateDefaultNamespaceSetting

public DefaultNamespaceSetting updateDefaultNamespaceSetting(UpdateDefaultNamespaceSettingRequest request)

Update the default namespace setting.

Updates the default namespace setting for the workspace. A fresh etag needs to be provided in PATCH requests (as part of the setting field). The etag can be retrieved by making a GET request before the PATCH request. Note that if the setting does not exist, GET will return a NOT_FOUND error and the etag will be present in the error response, which should be set in the PATCH request. If the setting is updated concurrently, PATCH will fail with 409 and the request will need to be retried by using the fresh etag in the 409 response.

updateRestrictWorkspaceAdminsSetting

public RestrictWorkspaceAdminsSetting updateRestrictWorkspaceAdminsSetting(boolean allowMissing,
                                                                           RestrictWorkspaceAdminsSetting setting,
                                                                           String fieldMask)

updateRestrictWorkspaceAdminsSetting

public RestrictWorkspaceAdminsSetting updateRestrictWorkspaceAdminsSetting(UpdateRestrictWorkspaceAdminsSettingRequest request)

Update the restrict workspace admins setting.

Updates the restrict workspace admins setting for the workspace. A fresh etag needs to be provided in PATCH requests (as part of the setting field). The etag can be retrieved by making a GET request before the PATCH request. If the setting is updated concurrently, PATCH will fail with 409 and the request will need to be retried by using the fresh etag in the 409 response.

impl

public SettingsService impl()