com.databricks.sdk.service.catalog

Class WorkspaceBindingsAPI

java.lang.Object

com.databricks.sdk.service.catalog.WorkspaceBindingsAPI

@Generated
public class WorkspaceBindingsAPI
extends Object

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

Constructor Summary

Constructors

Constructor and Description
WorkspaceBindingsAPI(ApiClient apiClient) Regular-use constructor
WorkspaceBindingsAPI(WorkspaceBindingsService mock) Constructor for mocks

Method Summary

Modifier and Type	Method and Description
GetCatalogWorkspaceBindingsResponse	get(GetWorkspaceBindingRequest request) Gets workspace bindings of the catalog.
GetCatalogWorkspaceBindingsResponse	get(String name)
Iterable<WorkspaceBinding>	getBindings(GetBindingsRequest request) Gets workspace bindings of the securable.
Iterable<WorkspaceBinding>	getBindings(String securableType, String securableName)
WorkspaceBindingsService	impl()
UpdateCatalogWorkspaceBindingsResponse	update(UpdateWorkspaceBindings request) Updates workspace bindings of the catalog.
UpdateWorkspaceBindingsResponse	updateBindings(UpdateWorkspaceBindingsParameters request) Updates workspace bindings of the securable.

Methods inherited from class java.lang.Object

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

Constructor Detail

WorkspaceBindingsAPI

public WorkspaceBindingsAPI(ApiClient apiClient)

Regular-use constructor

WorkspaceBindingsAPI

public WorkspaceBindingsAPI(WorkspaceBindingsService mock)

Constructor for mocks

Method Detail

get

public GetCatalogWorkspaceBindingsResponse get(String name)

get

public GetCatalogWorkspaceBindingsResponse get(GetWorkspaceBindingRequest request)

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

getBindings

public Iterable<WorkspaceBinding> getBindings(String securableType,
                                              String securableName)

getBindings

public Iterable<WorkspaceBinding> getBindings(GetBindingsRequest request)

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

public UpdateCatalogWorkspaceBindingsResponse update(UpdateWorkspaceBindings request)

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

updateBindings

public UpdateWorkspaceBindingsResponse updateBindings(UpdateWorkspaceBindingsParameters request)

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

impl

public WorkspaceBindingsService impl()