com.databricks.sdk.service.workspace

Interface WorkspaceService

@Generated
public interface WorkspaceService

The Workspace API allows you to list, import, export, and delete notebooks and folders.

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

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
void	delete(Delete delete) Delete a workspace object.
ExportResponse	export(ExportRequest exportRequest) Export a workspace object.
GetWorkspaceObjectPermissionLevelsResponse	getPermissionLevels(GetWorkspaceObjectPermissionLevelsRequest getWorkspaceObjectPermissionLevelsRequest) Get workspace object permission levels.
WorkspaceObjectPermissions	getPermissions(GetWorkspaceObjectPermissionsRequest getWorkspaceObjectPermissionsRequest) Get workspace object permissions.
ObjectInfo	getStatus(GetStatusRequest getStatusRequest) Get status.
void	importContent(Import importContent) Import a workspace object.
ListResponse	list(ListWorkspaceRequest listWorkspaceRequest) List contents.
void	mkdirs(Mkdirs mkdirs) Create a directory.
WorkspaceObjectPermissions	setPermissions(WorkspaceObjectPermissionsRequest workspaceObjectPermissionsRequest) Set workspace object permissions.
WorkspaceObjectPermissions	updatePermissions(WorkspaceObjectPermissionsRequest workspaceObjectPermissionsRequest) Update workspace object permissions.

Method Detail

delete

void delete(Delete delete)

Delete a workspace object.

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

ExportResponse export(ExportRequest exportRequest)

Export a workspace object.

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

GetWorkspaceObjectPermissionLevelsResponse getPermissionLevels(GetWorkspaceObjectPermissionLevelsRequest getWorkspaceObjectPermissionLevelsRequest)

Get workspace object permission levels.

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

getPermissions

WorkspaceObjectPermissions getPermissions(GetWorkspaceObjectPermissionsRequest getWorkspaceObjectPermissionsRequest)

Get workspace object permissions.

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

getStatus

ObjectInfo getStatus(GetStatusRequest getStatusRequest)

Get status.

Gets the status of an object or a directory. If `path` does not exist, this call returns an error `RESOURCE_DOES_NOT_EXIST`.

importContent

void importContent(Import importContent)

Import a workspace object.

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.

list

ListResponse list(ListWorkspaceRequest listWorkspaceRequest)

List contents.

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

void mkdirs(Mkdirs mkdirs)

Create a directory.

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

WorkspaceObjectPermissions setPermissions(WorkspaceObjectPermissionsRequest workspaceObjectPermissionsRequest)

Set workspace object permissions.

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

updatePermissions

WorkspaceObjectPermissions updatePermissions(WorkspaceObjectPermissionsRequest workspaceObjectPermissionsRequest)

Update workspace object permissions.

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