io.cdap.wrangler.store.workspace

Class WorkspaceStore

java.lang.Object

io.cdap.wrangler.store.workspace.WorkspaceStore

public class WorkspaceStore
extends Object

Workspace store for v2 endpoint

Field Summary

Fields

Modifier and Type	Field and Description
static io.cdap.cdap.spi.data.table.StructuredTableSpecification	WORKSPACE_TABLE_SPEC

Constructor Summary

Constructors

Constructor and Description
WorkspaceStore(io.cdap.cdap.spi.data.transaction.TransactionRunner transactionRunner)

Method Summary

Modifier and Type	Method and Description
void	deleteWorkspace(WorkspaceId workspaceId) Delete the given workspace
Workspace	getWorkspace(WorkspaceId workspaceId) Get the workspace about the given workspace id
WorkspaceDetail	getWorkspaceDetail(WorkspaceId workspaceId) Get the workspace detail about the given workspace id
List<Workspace>	listWorkspaces(io.cdap.cdap.api.NamespaceSummary namespace) Get all the workspaces in the given namespace
void	saveWorkspace(WorkspaceId workspaceId, WorkspaceDetail workspace) Create/update the workspace from given workspace.
void	updateWorkspace(WorkspaceId workspaceId, Workspace workspace) Save the new workspace metadata

Methods inherited from class java.lang.Object

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

Field Detail

WORKSPACE_TABLE_SPEC

public static final io.cdap.cdap.spi.data.table.StructuredTableSpecification WORKSPACE_TABLE_SPEC

Constructor Detail

WorkspaceStore

public WorkspaceStore(io.cdap.cdap.spi.data.transaction.TransactionRunner transactionRunner)

Method Detail

getWorkspace

public Workspace getWorkspace(WorkspaceId workspaceId)
                       throws WorkspaceNotFoundException

Get the workspace about the given workspace id

Parameters:

workspaceId - the id of the workspace to look up

Returns:

the workspace metadata about the given workspace id

Throws:

WorkspaceNotFoundException - if the workspace is not found

getWorkspaceDetail

public WorkspaceDetail getWorkspaceDetail(WorkspaceId workspaceId)
                                   throws WorkspaceNotFoundException

Get the workspace detail about the given workspace id

Parameters:

workspaceId - the id of the workspace to look up

Returns:

the workspace detail about the given workspace id

Throws:

WorkspaceNotFoundException - if the workspace is not found

listWorkspaces

public List<Workspace> listWorkspaces(io.cdap.cdap.api.NamespaceSummary namespace)

Get all the workspaces in the given namespace

Parameters:

namespace - the namespace to look up

Returns:

the list of workspaces in this namespace

saveWorkspace

public void saveWorkspace(WorkspaceId workspaceId,
                          WorkspaceDetail workspace)

Create/update the workspace from given workspace.

Parameters:

workspaceId - the id of the workspace

workspace - workspace to create/update

updateWorkspace

public void updateWorkspace(WorkspaceId workspaceId,
                            Workspace workspace)

Save the new workspace metadata

Parameters:

workspaceId - the workspace id

workspace - the new workspace meta to save

deleteWorkspace

public void deleteWorkspace(WorkspaceId workspaceId)
                     throws WorkspaceNotFoundException

Delete the given workspace

Parameters:

workspaceId - the workspace id to delete

Throws:

WorkspaceNotFoundException - if the workspace is not found