com.databricks.sdk.service.workspace

Class WorkspaceAPI

java.lang.Object

com.databricks.sdk.service.workspace.WorkspaceAPI

@Generated
public class WorkspaceAPI
extends Object

The Workspace API allows you to list, import, export, and delete workspace objects such as notebooks, files, folders, and dashboards. Additionally, it provides endpoints to manage permissions for any workspace object.

A notebook is a web-based interface to a document that contains runnable code, visualizations, and explanatory text.

Constructor Summary

Constructors

Constructor and Description
WorkspaceAPI(ApiClient apiClient) Regular-use constructor
WorkspaceAPI(WorkspaceService mock) Constructor for mocks

Method Summary

Modifier and Type	Method and Description
void	delete(Delete request) Deprecated: use WorkspaceHierarchyService.DeleteTreeNode instead.
ExportResponse	export(ExportRequest request) Exports an object or the contents of an entire directory.
ExportResponse	export(String path)
GetWorkspaceObjectPermissionLevelsResponse	getPermissionLevels(GetWorkspaceObjectPermissionLevelsRequest request) Gets the permission levels that a user can have on an object.
GetWorkspaceObjectPermissionLevelsResponse	getPermissionLevels(String workspaceObjectType, String workspaceObjectId)
WorkspaceObjectPermissions	getPermissions(GetWorkspaceObjectPermissionsRequest request) Gets the permissions of a workspace object.
WorkspaceObjectPermissions	getPermissions(String workspaceObjectType, String workspaceObjectId)
ObjectInfo	getStatus(GetStatusRequest request) Deprecated: use WorkspaceHierarchyService.GetTreeNode instead.
ObjectInfo	getStatus(String path)
WorkspaceService	impl()
void	importContent(Import request) Imports a workspace object (for example, a notebook or file) or the contents of an entire directory.
Iterable<ObjectInfo>	list(ListWorkspaceRequest request) Deprecated: use WorkspaceHierarchyService.ListTreeNodes instead.
Iterable<ObjectInfo>	list(String path)
void	mkdirs(Mkdirs request) Deprecated: use WorkspaceHierarchyService.CreateTreeNode instead.
void	mkdirs(String path)
WorkspaceObjectPermissions	setPermissions(WorkspaceObjectPermissionsRequest request) Sets permissions on an object, replacing existing permissions if they exist.
WorkspaceObjectPermissions	updatePermissions(WorkspaceObjectPermissionsRequest request) Updates the permissions on a workspace object.

Methods inherited from class java.lang.Object

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

Constructor Detail

WorkspaceAPI

public WorkspaceAPI(ApiClient apiClient)

Regular-use constructor

WorkspaceAPI

public WorkspaceAPI(WorkspaceService mock)

Constructor for mocks

Method Detail

delete

public void delete(Delete request)

Deprecated: use WorkspaceHierarchyService.DeleteTreeNode instead. Deletes an object or a directory (and optionally recursively deletes all objects in the directory). * If `path` does not exist, this call returns an error `RESOURCE_DOES_NOT_EXIST`. * If `path` is a non-empty directory and `recursive` is set to `false`, this call returns an error `DIRECTORY_NOT_EMPTY`.

Object deletion cannot be undone and deleting a directory recursively is not atomic.

export

public ExportResponse export(String path)

export

public ExportResponse export(ExportRequest request)

Exports an object or the contents of an entire directory.

If `path` does not exist, this call returns an error `RESOURCE_DOES_NOT_EXIST`.

If the exported data would exceed size limit, this call returns `MAX_NOTEBOOK_SIZE_EXCEEDED`. Currently, this API does not support exporting a library.

getPermissionLevels

public GetWorkspaceObjectPermissionLevelsResponse getPermissionLevels(String workspaceObjectType,
                                                                      String workspaceObjectId)

getPermissionLevels

public GetWorkspaceObjectPermissionLevelsResponse getPermissionLevels(GetWorkspaceObjectPermissionLevelsRequest request)

Gets the permission levels that a user can have on an object.

getPermissions

public WorkspaceObjectPermissions getPermissions(String workspaceObjectType,
                                                 String workspaceObjectId)

getPermissions

public WorkspaceObjectPermissions getPermissions(GetWorkspaceObjectPermissionsRequest request)

Gets the permissions of a workspace object. Workspace objects can inherit permissions from their parent objects or root object.

getStatus

public ObjectInfo getStatus(String path)

getStatus

public ObjectInfo getStatus(GetStatusRequest request)

Deprecated: use WorkspaceHierarchyService.GetTreeNode instead. Gets the status of an object or a directory. If `path` does not exist, this call returns an error `RESOURCE_DOES_NOT_EXIST`.

importContent

public void importContent(Import request)

Imports a workspace object (for example, a notebook or file) or the contents of an entire directory. If `path` already exists and `overwrite` is set to `false`, this call returns an error `RESOURCE_ALREADY_EXISTS`. To import a directory, you can use either the `DBC` format or the `SOURCE` format with the `language` field unset. To import a single file as `SOURCE`, you must set the `language` field. Zip files within directories are not supported.

list

public Iterable<ObjectInfo> list(String path)

list

public Iterable<ObjectInfo> list(ListWorkspaceRequest request)

Deprecated: use WorkspaceHierarchyService.ListTreeNodes instead. Lists the contents of a directory, or the object if it is not a directory. If the input path does not exist, this call returns an error `RESOURCE_DOES_NOT_EXIST`.

mkdirs

public void mkdirs(String path)

mkdirs

public void mkdirs(Mkdirs request)

Deprecated: use WorkspaceHierarchyService.CreateTreeNode instead. Creates the specified directory (and necessary parent directories if they do not exist). If there is an object (not a directory) at any prefix of the input path, this call returns an error `RESOURCE_ALREADY_EXISTS`.

Note that if this operation fails it may have succeeded in creating some of the necessary parent directories.

setPermissions

public WorkspaceObjectPermissions setPermissions(WorkspaceObjectPermissionsRequest request)

Sets permissions on an object, replacing existing permissions if they exist. Deletes all direct permissions if none are specified. Objects can inherit permissions from their parent objects or root object.

updatePermissions

public WorkspaceObjectPermissions updatePermissions(WorkspaceObjectPermissionsRequest request)

Updates the permissions on a workspace object. Workspace objects can inherit permissions from their parent objects or root object.

impl

public WorkspaceService impl()