io.cdap.wrangler.dataset.workspace

Class WorkspaceDataset

java.lang.Object

io.cdap.wrangler.dataset.workspace.WorkspaceDataset

Deprecated.

@Deprecated
public class WorkspaceDataset
extends Object

Workspace store for workspaces and a special row for the DirectiveConfig, which allows admins to configure a directive blacklist and to alias directives to other names. A workspace contains a data sample, metadata about the workspace, and a set of directives that can be used to process the data sample. A workspace is tagged with a scope, which can be used to group workspaces together. It also stores a map of properties, which are connection specific properties that are used to generate the pipeline source configuration when a pipeline is created from a workspace. The dataset is stored in a single table with columns: namespace, id, name, type, scope, created, updated, properties, data, and request

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_SCOPE Deprecated.
static io.cdap.cdap.spi.data.table.StructuredTableSpecification	TABLE_SPEC Deprecated.

Constructor Summary

Constructors

Constructor and Description
WorkspaceDataset(io.cdap.cdap.spi.data.StructuredTable table) Deprecated.

Method Summary

Modifier and Type	Method and Description
NamespacedId	createWorkspace(Namespace namespace, WorkspaceMeta meta) Deprecated. Creates a new workspace
int	deleteScope(Namespace namespace, String scope) Deprecated. Deletes a workspaces that have the specified scope.
void	deleteWorkspace(NamespacedId id) Deprecated. Deletes the workspace.
static WorkspaceDataset	get(io.cdap.cdap.spi.data.StructuredTableContext context) Deprecated.
Workspace	getWorkspace(NamespacedId id) Deprecated. Get information about the workspace.
boolean	hasWorkspace(NamespacedId id) Deprecated. Checks if a workspace exists.
List<WorkspaceIdentifier>	listWorkspaces(Namespace namespace, String scope) Deprecated. Lists all the workspaces registered for a scope.
List<Workspace>	listWorkspaces(io.cdap.cdap.api.NamespaceSummary namespace, long timestampSeconds) Deprecated. LLists all the workspaces before timestamp.
void	updateWorkspaceData(NamespacedId id, DataType dataType, byte[] data) Deprecated. Update the sample data for the specified workspace.
void	updateWorkspaceProperties(NamespacedId id, Map<String,String> properties) Deprecated. Update the properties of the specified workspace.
void	updateWorkspaceRequest(NamespacedId id, Request request) Deprecated. Update the directive execution request for the specified workspace.
void	writeWorkspaceMeta(NamespacedId id, WorkspaceMeta meta) Deprecated. Creates a workspace if it does not already exist, or update an existing workspace if it does.

Methods inherited from class java.lang.Object

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

Field Detail

TABLE_SPEC

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

Deprecated.

DEFAULT_SCOPE

public static final String DEFAULT_SCOPE

Deprecated.

See Also:

Constant Field Values

Constructor Detail

WorkspaceDataset

public WorkspaceDataset(io.cdap.cdap.spi.data.StructuredTable table)

Deprecated.

Method Detail

get

public static WorkspaceDataset get(io.cdap.cdap.spi.data.StructuredTableContext context)

Deprecated.

createWorkspace

public NamespacedId createWorkspace(Namespace namespace,
                                    WorkspaceMeta meta)
                             throws IOException

Deprecated.

Creates a new workspace

Parameters:

namespace - the namespace to create the workspace in

meta - the workspace metadata

Returns:

the id of the newly created workspace

Throws:

IOException

writeWorkspaceMeta

public void writeWorkspaceMeta(NamespacedId id,
                               WorkspaceMeta meta)
                        throws IOException

Deprecated.

Creates a workspace if it does not already exist, or update an existing workspace if it does.

Parameters:

id - the id of the workspace to write

meta - the workspace metadata

Throws:

IOException

getWorkspace

public Workspace getWorkspace(NamespacedId id)
                       throws WorkspaceNotFoundException,
                              IOException

Deprecated.

Get information about the workspace.

Parameters:

id - the workspace id

Returns:

information about the workspace

Throws:

WorkspaceNotFoundException - if the workspace does not exist

IOException

hasWorkspace

public boolean hasWorkspace(NamespacedId id)
                     throws IOException

Deprecated.

Checks if a workspace exists.

Parameters:

id - of the workspace to be checked for.

Returns:

true if workspace exists, false otherwise.

Throws:

IOException

listWorkspaces

public List<WorkspaceIdentifier> listWorkspaces(Namespace namespace,
                                                String scope)
                                         throws IOException

Deprecated.

Lists all the workspaces registered for a scope.

Returns:

List of workspaces.

Throws:

IOException

listWorkspaces

public List<Workspace> listWorkspaces(io.cdap.cdap.api.NamespaceSummary namespace,
                                      long timestampSeconds)
                               throws IOException

Deprecated.

LLists all the workspaces before timestamp.

Returns:

List of workspaces.

Throws:

IOException

updateWorkspaceProperties

public void updateWorkspaceProperties(NamespacedId id,
                                      Map<String,String> properties)
                               throws WorkspaceNotFoundException,
                                      IOException

Deprecated.

Update the properties of the specified workspace.

Parameters:

id - the workspace id

properties - the properties to update

Throws:

WorkspaceNotFoundException - if the workspace does not exist

IOException

updateWorkspaceRequest

public void updateWorkspaceRequest(NamespacedId id,
                                   Request request)
                            throws WorkspaceNotFoundException,
                                   IOException

Deprecated.

Update the directive execution request for the specified workspace.

Parameters:

id - the workspace id

request - the directive execution request

Throws:

WorkspaceNotFoundException - if the workspace does not exist

IOException

updateWorkspaceData

public void updateWorkspaceData(NamespacedId id,
                                DataType dataType,
                                byte[] data)
                         throws WorkspaceNotFoundException,
                                IOException

Deprecated.

Update the sample data for the specified workspace.

Parameters:

id - the workspace id

data - the sample data

Throws:

WorkspaceNotFoundException - if the workspace does not exist

IOException

deleteWorkspace

public void deleteWorkspace(NamespacedId id)
                     throws IOException

Deprecated.

Deletes the workspace.

Parameters:

id - to be deleted.

Throws:

IOException

deleteScope

public int deleteScope(Namespace namespace,
                       String scope)
                throws IOException

Deprecated.

Deletes a workspaces that have the specified scope. TODO: (CDAP-14692) make sure scope is indexed so this doesn't require a full table scan

Parameters:

scope - to be deleted

Returns:

number of workspaces deleted

Throws:

IOException