com.edmunds.rest.databricks.service

Interface WorkspaceService

All Known Implementing Classes:

WorkspaceServiceImpl

public interface WorkspaceService

Wrapper around the Worspace API.

See Also:

https://docs.databricks.com/api/latest/workspace.html

Method Summary

Modifier and Type	Method and Description
void	delete(String path, boolean recursive) Deletes a specific workspace path.
byte[]	exportWorkspace(ExportWorkspaceRequest exportWorkspaceRequest) Exports a workspace path FROM databricks to local machine.
ObjectInfoDTO	getStatus(String path) Gets the status of a specific workspace path.
void	importWorkspace(ImportWorkspaceRequest importWorkspaceRequest) Imports files INTO databricks from local machine.
ObjectInfoDTO[]	listStatus(String path) Lists all objects in a specific db workspace path.
void	mkdirs(String path) Makes a path (and any parent paths if they do not exist) on db workspace.

Method Detail

delete

void delete(String path,
            boolean recursive)
     throws IOException,
            DatabricksRestException

Deletes a specific workspace path.

Parameters:

path - the workspace path to delete

recursive - whether or not its recursive

Throws:

IOException - any other errors

DatabricksRestException - databricks specific errors

See Also:

https://docs.databricks.com/api/latest/workspace.html#delete

exportWorkspace

byte[] exportWorkspace(ExportWorkspaceRequest exportWorkspaceRequest)
                throws IOException,
                       DatabricksRestException

Exports a workspace path FROM databricks to local machine.

Parameters:

exportWorkspaceRequest - the request object

Returns:

the bytes of the export

Throws:

IOException - any other errors

DatabricksRestException - any specific db errors

See Also:

https://docs.databricks.com/api/latest/workspace.html#export

getStatus

ObjectInfoDTO getStatus(String path)
                 throws IOException,
                        DatabricksRestException

Gets the status of a specific workspace path.

Parameters:

path - the workspace path

Returns:

the workspace info object

Throws:

IOException - any other errors

DatabricksRestException - any specific db errors

See Also:

https://docs.databricks.com/api/latest/workspace.html#get-status

importWorkspace

void importWorkspace(ImportWorkspaceRequest importWorkspaceRequest)
              throws IOException,
                     DatabricksRestException

Imports files INTO databricks from local machine.

Parameters:

importWorkspaceRequest - the import workspace request

Throws:

IOException - any other errors

DatabricksRestException - specific db exceptions

See Also:

https://docs.databricks.com/api/latest/workspace.html#import

listStatus

ObjectInfoDTO[] listStatus(String path)
                    throws IOException,
                           DatabricksRestException

Lists all objects in a specific db workspace path.

Parameters:

path - the db workspace path

Returns:

the array of objects

Throws:

IOException - any other errors

DatabricksRestException - specific db exceptions

See Also:

https://docs.databricks.com/api/latest/workspace.html#list

mkdirs

void mkdirs(String path)
     throws IOException,
            DatabricksRestException

Makes a path (and any parent paths if they do not exist) on db workspace.

Parameters:

path - the db workspace path to create

Throws:

IOException - any other errors

DatabricksRestException - any specific db exceptions

See Also:

https://docs.databricks.com/api/latest/workspace.html#mkdirs