io.cdap.wrangler.service.directive

Class WorkspaceHandler

java.lang.Object

io.cdap.cdap.internal.api.AbstractProgramDatasetConfigurable<T>

io.cdap.cdap.internal.api.AbstractPluginConfigurable<V>

io.cdap.cdap.api.service.http.AbstractHttpServiceHandler<io.cdap.cdap.api.service.http.SystemHttpServiceContext,io.cdap.cdap.api.service.http.SystemHttpServiceConfigurer>

io.cdap.cdap.api.service.http.AbstractSystemHttpServiceHandler

io.cdap.wrangler.service.common.AbstractWranglerHandler

io.cdap.wrangler.service.directive.AbstractDirectiveHandler

io.cdap.wrangler.service.directive.WorkspaceHandler

All Implemented Interfaces:

io.cdap.cdap.api.ProgramLifecycle<io.cdap.cdap.api.service.http.SystemHttpServiceContext>, io.cdap.cdap.api.service.http.HttpServiceHandler<io.cdap.cdap.api.service.http.SystemHttpServiceContext,io.cdap.cdap.api.service.http.SystemHttpServiceConfigurer>

public class WorkspaceHandler
extends AbstractDirectiveHandler

V2 endpoints for workspace

Nested Class Summary

Nested classes/interfaces inherited from class io.cdap.wrangler.service.common.AbstractWranglerHandler

AbstractWranglerHandler.NamespacedResponder<T>, AbstractWranglerHandler.NamespacedResponderRunnable

Field Summary

Fields inherited from class io.cdap.wrangler.service.directive.AbstractDirectiveHandler

COLUMN_NAME, composite, DELIMITER_HEADER, RECORD_DELIMITER_HEADER

Constructor Summary

Constructors

Constructor and Description
WorkspaceHandler()

Method Summary

Modifier and Type	Method and Description
void	createWorkspace(io.cdap.cdap.api.service.http.HttpServiceRequest request, io.cdap.cdap.api.service.http.HttpServiceResponder responder, String namespace)
void	deleteWorkspace(io.cdap.cdap.api.service.http.HttpServiceRequest request, io.cdap.cdap.api.service.http.HttpServiceResponder responder, String namespace, String workspaceId)
void	execute(io.cdap.cdap.api.service.http.HttpServiceRequest request, io.cdap.cdap.api.service.http.HttpServiceResponder responder, String namespace, String workspaceId) Executes the directives on the record.
void	getDirectives(io.cdap.cdap.api.service.http.HttpServiceRequest request, io.cdap.cdap.api.service.http.HttpServiceResponder responder, String namespace) Retrieve the directives available in the namespace
void	getWorkspace(io.cdap.cdap.api.service.http.HttpServiceRequest request, io.cdap.cdap.api.service.http.HttpServiceResponder responder, String namespace, String workspaceId)
void	initialize(io.cdap.cdap.api.service.http.SystemHttpServiceContext context)
void	listWorkspaces(io.cdap.cdap.api.service.http.HttpServiceRequest request, io.cdap.cdap.api.service.http.HttpServiceResponder responder, String namespace)
void	resampleWorkspace(io.cdap.cdap.api.service.http.HttpServiceRequest request, io.cdap.cdap.api.service.http.HttpServiceResponder responder, String namespace, String workspaceId) Resample the workspace using a new sample request.
void	specification(io.cdap.cdap.api.service.http.HttpServiceRequest request, io.cdap.cdap.api.service.http.HttpServiceResponder responder, String namespace, String workspaceId) Get the specification for the workspace
void	updateWorkspace(io.cdap.cdap.api.service.http.HttpServiceRequest request, io.cdap.cdap.api.service.http.HttpServiceResponder responder, String namespace, String workspaceId) Update the workspace's directives and initiatives
void	upload(io.cdap.cdap.api.service.http.HttpServiceRequest request, io.cdap.cdap.api.service.http.HttpServiceResponder responder, String namespace) Upload data to the workspace, the workspace is created automatically on fly.

Methods inherited from class io.cdap.wrangler.service.directive.AbstractDirectiveHandler

createUberRecord, destroy, executeDirectives, generateExecutionResponse, getWorkspaceSummary

Methods inherited from class io.cdap.wrangler.service.common.AbstractWranglerHandler

getConnection, getValidatedConnection, getValidatedConnection, getWorkspace, respond, respond, respond, shouldCopyHeader

Methods inherited from class io.cdap.cdap.api.service.http.AbstractSystemHttpServiceHandler

createTable

Methods inherited from class io.cdap.cdap.api.service.http.AbstractHttpServiceHandler

configure, configure, getConfigurer, getContext, setProperties

Methods inherited from class io.cdap.cdap.internal.api.AbstractPluginConfigurable

usePlugin, usePlugin, usePluginClass, usePluginClass

Methods inherited from class io.cdap.cdap.internal.api.AbstractProgramDatasetConfigurable

addDatasetModule, addDatasetType, createDataset, createDataset, createDataset, createDataset

Methods inherited from class java.lang.Object

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

Constructor Detail

WorkspaceHandler

public WorkspaceHandler()

Method Detail

initialize

public void initialize(io.cdap.cdap.api.service.http.SystemHttpServiceContext context)
                throws Exception

Specified by:

initialize in interface io.cdap.cdap.api.ProgramLifecycle<io.cdap.cdap.api.service.http.SystemHttpServiceContext>

Specified by:

initialize in interface io.cdap.cdap.api.service.http.HttpServiceHandler<io.cdap.cdap.api.service.http.SystemHttpServiceContext,io.cdap.cdap.api.service.http.SystemHttpServiceConfigurer>

Overrides:

initialize in class AbstractDirectiveHandler

Throws:

Exception

createWorkspace

@POST
 @Path(value="v2/contexts/{context}/workspaces")
public void createWorkspace(io.cdap.cdap.api.service.http.HttpServiceRequest request,
                                                                                   io.cdap.cdap.api.service.http.HttpServiceResponder responder,
                                                                                   @PathParam(value="context")
                                                                                   String namespace)

listWorkspaces

@GET
 @Path(value="v2/contexts/{context}/workspaces")
public void listWorkspaces(io.cdap.cdap.api.service.http.HttpServiceRequest request,
                                                                                 io.cdap.cdap.api.service.http.HttpServiceResponder responder,
                                                                                 @PathParam(value="context")
                                                                                 String namespace)

getWorkspace

@GET
 @Path(value="v2/contexts/{context}/workspaces/{id}")
public void getWorkspace(io.cdap.cdap.api.service.http.HttpServiceRequest request,
                                                                                    io.cdap.cdap.api.service.http.HttpServiceResponder responder,
                                                                                    @PathParam(value="context")
                                                                                    String namespace,
                                                                                    @PathParam(value="id")
                                                                                    String workspaceId)

updateWorkspace

@POST
 @Path(value="v2/contexts/{context}/workspaces/{id}")
public void updateWorkspace(io.cdap.cdap.api.service.http.HttpServiceRequest request,
                                                                                        io.cdap.cdap.api.service.http.HttpServiceResponder responder,
                                                                                        @PathParam(value="context")
                                                                                        String namespace,
                                                                                        @PathParam(value="id")
                                                                                        String workspaceId)

Update the workspace's directives and initiatives

resampleWorkspace

@POST
 @Path(value="v2/contexts/{context}/workspaces/{id}/resample")
public void resampleWorkspace(io.cdap.cdap.api.service.http.HttpServiceRequest request,
                                                                                                   io.cdap.cdap.api.service.http.HttpServiceResponder responder,
                                                                                                   @PathParam(value="context")
                                                                                                   String namespace,
                                                                                                   @PathParam(value="id")
                                                                                                   String workspaceId)

Resample the workspace using a new sample request. Keeps all previously-applied directives.

deleteWorkspace

@DELETE
 @Path(value="v2/contexts/{context}/workspaces/{id}")
public void deleteWorkspace(io.cdap.cdap.api.service.http.HttpServiceRequest request,
                                                                                          io.cdap.cdap.api.service.http.HttpServiceResponder responder,
                                                                                          @PathParam(value="context")
                                                                                          String namespace,
                                                                                          @PathParam(value="id")
                                                                                          String workspaceId)

upload

@POST
 @Path(value="v2/contexts/{context}/workspaces/upload")
public void upload(io.cdap.cdap.api.service.http.HttpServiceRequest request,
                                                                                 io.cdap.cdap.api.service.http.HttpServiceResponder responder,
                                                                                 @PathParam(value="context")
                                                                                 String namespace)

Upload data to the workspace, the workspace is created automatically on fly.

execute

@POST
 @Path(value="v2/contexts/{context}/workspaces/{id}/execute")
public void execute(io.cdap.cdap.api.service.http.HttpServiceRequest request,
                                                                                        io.cdap.cdap.api.service.http.HttpServiceResponder responder,
                                                                                        @PathParam(value="context")
                                                                                        String namespace,
                                                                                        @PathParam(value="id")
                                                                                        String workspaceId)

Executes the directives on the record.

getDirectives

@GET
 @Path(value="v2/contexts/{context}/directives")
public void getDirectives(io.cdap.cdap.api.service.http.HttpServiceRequest request,
                                                                                io.cdap.cdap.api.service.http.HttpServiceResponder responder,
                                                                                @PathParam(value="context")
                                                                                String namespace)

Retrieve the directives available in the namespace

specification

@GET
 @Path(value="v2/contexts/{context}/workspaces/{id}/specification")
public void specification(io.cdap.cdap.api.service.http.HttpServiceRequest request,
                                                                                                   io.cdap.cdap.api.service.http.HttpServiceResponder responder,
                                                                                                   @PathParam(value="context")
                                                                                                   String namespace,
                                                                                                   @PathParam(value="id")
                                                                                                   String workspaceId)

Get the specification for the workspace