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 notebooks and folders.

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) Delete a workspace object.
void	delete(String path)
ExportResponse	export(ExportRequest request) Export a workspace object.
ExportResponse	export(String path)
ObjectInfo	getStatus(GetStatusRequest request) Get status.
ObjectInfo	getStatus(String path)
GetWorkspaceObjectPermissionLevelsResponse	getWorkspaceObjectPermissionLevels(GetWorkspaceObjectPermissionLevelsRequest request) Get workspace object permission levels.
GetWorkspaceObjectPermissionLevelsResponse	getWorkspaceObjectPermissionLevels(String workspaceObjectType, String workspaceObjectId)
WorkspaceObjectPermissions	getWorkspaceObjectPermissions(GetWorkspaceObjectPermissionsRequest request) Get workspace object permissions.
WorkspaceObjectPermissions	getWorkspaceObjectPermissions(String workspaceObjectType, String workspaceObjectId)
WorkspaceService	impl()
void	importContent(Import request) Import a workspace object.
void	importContent(String path)
Iterable<ObjectInfo>	list(ListWorkspaceRequest request) List contents.
Iterable<ObjectInfo>	list(String path)
void	mkdirs(Mkdirs request) Create a directory.
void	mkdirs(String path)
WorkspaceObjectPermissions	setWorkspaceObjectPermissions(String workspaceObjectType, String workspaceObjectId)
WorkspaceObjectPermissions	setWorkspaceObjectPermissions(WorkspaceObjectPermissionsRequest request) Set workspace object permissions.
WorkspaceObjectPermissions	updateWorkspaceObjectPermissions(String workspaceObjectType, String workspaceObjectId)
WorkspaceObjectPermissions	updateWorkspaceObjectPermissions(WorkspaceObjectPermissionsRequest request) Update workspace object permissions.

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(String path)

delete

public void delete(Delete request)

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

public ExportResponse export(String path)

export

public ExportResponse export(ExportRequest request)

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.

getStatus

public ObjectInfo getStatus(String path)

getStatus

public ObjectInfo getStatus(GetStatusRequest request)

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

getWorkspaceObjectPermissionLevels

public GetWorkspaceObjectPermissionLevelsResponse getWorkspaceObjectPermissionLevels(String workspaceObjectType,
                                                                                     String workspaceObjectId)

getWorkspaceObjectPermissionLevels

public GetWorkspaceObjectPermissionLevelsResponse getWorkspaceObjectPermissionLevels(GetWorkspaceObjectPermissionLevelsRequest request)

Get workspace object permission levels.

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

getWorkspaceObjectPermissions

public WorkspaceObjectPermissions getWorkspaceObjectPermissions(String workspaceObjectType,
                                                                String workspaceObjectId)

getWorkspaceObjectPermissions

public WorkspaceObjectPermissions getWorkspaceObjectPermissions(GetWorkspaceObjectPermissionsRequest request)

Get workspace object permissions.

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

importContent

public void importContent(String path)

importContent

public void importContent(Import request)

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`. One can only use `DBC` format to import a directory.

list

public Iterable<ObjectInfo> list(String path)

list

public Iterable<ObjectInfo> list(ListWorkspaceRequest request)

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

public void mkdirs(String path)

mkdirs

public void mkdirs(Mkdirs request)

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.

setWorkspaceObjectPermissions

public WorkspaceObjectPermissions setWorkspaceObjectPermissions(String workspaceObjectType,
                                                                String workspaceObjectId)

setWorkspaceObjectPermissions

public WorkspaceObjectPermissions setWorkspaceObjectPermissions(WorkspaceObjectPermissionsRequest request)

Set workspace object permissions.

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

updateWorkspaceObjectPermissions

public WorkspaceObjectPermissions updateWorkspaceObjectPermissions(String workspaceObjectType,
                                                                   String workspaceObjectId)

updateWorkspaceObjectPermissions

public WorkspaceObjectPermissions updateWorkspaceObjectPermissions(WorkspaceObjectPermissionsRequest request)

Update workspace object permissions.

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

impl

public WorkspaceService impl()