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
DeleteDefaultWorkspaceNamespaceResponse	deleteDefaultWorkspaceNamespace(DeleteDefaultWorkspaceNamespaceRequest request) Delete the default namespace setting.
DeleteDefaultWorkspaceNamespaceResponse	deleteDefaultWorkspaceNamespace(String etag)
SettingsService	impl()
DefaultNamespaceSetting	readDefaultWorkspaceNamespace(ReadDefaultWorkspaceNamespaceRequest request) Get the default namespace setting.
DefaultNamespaceSetting	readDefaultWorkspaceNamespace(String etag)
DefaultNamespaceSetting	updateDefaultWorkspaceNamespace(UpdateDefaultWorkspaceNamespaceRequest request) Update the default namespace 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

deleteDefaultWorkspaceNamespace

public DeleteDefaultWorkspaceNamespaceResponse deleteDefaultWorkspaceNamespace(String etag)

deleteDefaultWorkspaceNamespace

public DeleteDefaultWorkspaceNamespaceResponse deleteDefaultWorkspaceNamespace(DeleteDefaultWorkspaceNamespaceRequest 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.

readDefaultWorkspaceNamespace

public DefaultNamespaceSetting readDefaultWorkspaceNamespace(String etag)

readDefaultWorkspaceNamespace

public DefaultNamespaceSetting readDefaultWorkspaceNamespace(ReadDefaultWorkspaceNamespaceRequest request)

Get the default namespace setting.

Gets the default namespace setting.

updateDefaultWorkspaceNamespace

public DefaultNamespaceSetting updateDefaultWorkspaceNamespace(UpdateDefaultWorkspaceNamespaceRequest 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.

impl

public SettingsService impl()