io.cdap.wrangler.service.gcs

Class GCSHandler

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.gcs.GCSHandler

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 GCSHandler
extends AbstractWranglerHandler

Service to explore GCS filesystem

Nested Class Summary

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

AbstractWranglerHandler.NamespacedResponder<T>

Constructor Summary

Constructors

Constructor and Description
GCSHandler()

Method Summary

Modifier and Type	Method and Description
void	exploreGCS(io.cdap.cdap.api.service.http.HttpServiceRequest request, io.cdap.cdap.api.service.http.HttpServiceResponder responder, String namespace, String connectionId, String path, int objectLimit) Lists GCS bucket's contents for the given prefix path.
void	initialize(io.cdap.cdap.api.service.http.SystemHttpServiceContext context)
void	loadObject(io.cdap.cdap.api.service.http.HttpServiceRequest request, io.cdap.cdap.api.service.http.HttpServiceResponder responder, String namespace, String connectionId, String bucket, String blobPath, String scope) Reads GCS object into workspace.
void	specification(io.cdap.cdap.api.service.http.HttpServiceRequest request, io.cdap.cdap.api.service.http.HttpServiceResponder responder, String namespace, String connectionId, String workspaceId) Specification for the source.
void	testGCSConnection(io.cdap.cdap.api.service.http.HttpServiceRequest request, io.cdap.cdap.api.service.http.HttpServiceResponder responder, String namespace)

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

getConnection, getValidatedConnection, getValidatedConnection, getWorkspace, 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, destroy, 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

GCSHandler

public GCSHandler()

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 io.cdap.cdap.api.service.http.AbstractHttpServiceHandler<io.cdap.cdap.api.service.http.SystemHttpServiceContext,io.cdap.cdap.api.service.http.SystemHttpServiceConfigurer>

Throws:

Exception

testGCSConnection

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

exploreGCS

@GET
 @Path(value="contexts/{context}/connections/{connection-id}/gcs/explore")
public void exploreGCS(io.cdap.cdap.api.service.http.HttpServiceRequest request,
                                                                                                       io.cdap.cdap.api.service.http.HttpServiceResponder responder,
                                                                                                       @PathParam(value="context")
                                                                                                       String namespace,
                                                                                                       @PathParam(value="connection-id")
                                                                                                       String connectionId,
                                                                                                       @QueryParam(value="path")
                                                                                                       String path,
                                                                                                       @QueryParam(value="limit") @DefaultValue(value="1000")
                                                                                                       int objectLimit)

Lists GCS bucket's contents for the given prefix path.

Parameters:

request - HTTP Request handler.

responder - HTTP Response handler.

loadObject

@GET
 @Path(value="contexts/{context}/connections/{connection-id}/gcs/buckets/{bucket}/read")
public void loadObject(io.cdap.cdap.api.service.http.HttpServiceRequest request,
                                                                                                                     io.cdap.cdap.api.service.http.HttpServiceResponder responder,
                                                                                                                     @PathParam(value="context")
                                                                                                                     String namespace,
                                                                                                                     @PathParam(value="connection-id")
                                                                                                                     String connectionId,
                                                                                                                     @PathParam(value="bucket")
                                                                                                                     String bucket,
                                                                                                                     @QueryParam(value="blob")
                                                                                                                     String blobPath,
                                                                                                                     @QueryParam(value="scope") @DefaultValue(value="default")
                                                                                                                     String scope)

Reads GCS object into workspace.

Parameters:

request - HTTP Request handler.

responder - HTTP Response handler.

specification

@GET
 @Path(value="contexts/{context}/connections/{connection-id}/gcs/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="connection-id")
                                                                                                                String connectionId,
                                                                                                                @QueryParam(value="wid")
                                                                                                                String workspaceId)

Specification for the source.

Parameters:

request - HTTP request handler.

responder - HTTP response handler.