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).

Securables that support binding: - catalog

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
CurrentWorkspaceBindings	get(GetWorkspaceBindingRequest getWorkspaceBindingRequest) Get catalog workspace bindings.
WorkspaceBindingsResponse	getBindings(GetBindingsRequest getBindingsRequest) Get securable workspace bindings.
CurrentWorkspaceBindings	update(UpdateWorkspaceBindings updateWorkspaceBindings) Update catalog workspace bindings.
WorkspaceBindingsResponse	updateBindings(UpdateWorkspaceBindingsParameters updateWorkspaceBindingsParameters) Update securable workspace bindings.

Method Detail

get

CurrentWorkspaceBindings get(GetWorkspaceBindingRequest getWorkspaceBindingRequest)

Get catalog workspace bindings.

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

getBindings

WorkspaceBindingsResponse getBindings(GetBindingsRequest getBindingsRequest)

Get securable workspace bindings.

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

update

CurrentWorkspaceBindings update(UpdateWorkspaceBindings updateWorkspaceBindings)

Update catalog workspace bindings.

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

updateBindings

WorkspaceBindingsResponse updateBindings(UpdateWorkspaceBindingsParameters updateWorkspaceBindingsParameters)

Update securable workspace bindings.

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