com.databricks.sdk.service.catalog

Interface WorkspaceBindingsService

@Generated
public interface WorkspaceBindingsService

A securable in Databricks can be configured as __OPEN__ or __ISOLATED__. An __OPEN__ securable can be accessed from any workspace, while an __ISOLATED__ securable can only be accessed from a configured list of workspaces. This API allows you to configure (bind) securables to workspaces.

NOTE: The __isolation_mode__ is configured for the securable itself (using its Update method) and the workspace bindings are only consulted when the securable's __isolation_mode__ is set to __ISOLATED__.

A securable's workspace bindings can be configured by a metastore admin or the owner of the securable.

The original path (/api/2.1/unity-catalog/workspace-bindings/catalogs/{name}) is deprecated. Please use the new path (/api/2.1/unity-catalog/bindings/{securable_type}/{securable_name}) which introduces the ability to bind a securable in READ_ONLY mode (catalogs only).

Securable types that support binding: - catalog - storage_credential - credential - external_location

This is the high-level interface, that contains generated methods.

Evolving: this interface is under development. Method signatures may change.

Method Summary

Modifier and Type	Method and Description
GetCatalogWorkspaceBindingsResponse	get(GetWorkspaceBindingRequest getWorkspaceBindingRequest) Gets workspace bindings of the catalog.
GetWorkspaceBindingsResponse	getBindings(GetBindingsRequest getBindingsRequest) Gets workspace bindings of the securable.
UpdateCatalogWorkspaceBindingsResponse	update(UpdateWorkspaceBindings updateWorkspaceBindings) Updates workspace bindings of the catalog.
UpdateWorkspaceBindingsResponse	updateBindings(UpdateWorkspaceBindingsParameters updateWorkspaceBindingsParameters) Updates workspace bindings of the securable.

Method Detail

get

GetCatalogWorkspaceBindingsResponse get(GetWorkspaceBindingRequest getWorkspaceBindingRequest)

Gets workspace bindings of the catalog. The caller must be a metastore admin or an owner of the catalog.

getBindings

GetWorkspaceBindingsResponse getBindings(GetBindingsRequest getBindingsRequest)

Gets workspace bindings of the securable. The caller must be a metastore admin or an owner of the securable.

NOTE: we recommend using max_results=0 to use the paginated version of this API. Unpaginated calls will be deprecated soon.

PAGINATION BEHAVIOR: When using pagination (max_results >= 0), a page may contain zero results while still providing a next_page_token. Clients must continue reading pages until next_page_token is absent, which is the only indication that the end of results has been reached.

update

UpdateCatalogWorkspaceBindingsResponse update(UpdateWorkspaceBindings updateWorkspaceBindings)

Updates workspace bindings of the catalog. The caller must be a metastore admin or an owner of the catalog.

updateBindings

UpdateWorkspaceBindingsResponse updateBindings(UpdateWorkspaceBindingsParameters updateWorkspaceBindingsParameters)

Updates workspace bindings of the securable. The caller must be a metastore admin or an owner of the securable.