io.cdap.wrangler.service.bigquery

Class BigQueryHandler

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.bigquery.BigQueryHandler

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

Service for testing, browsing, and reading using a BigQuery connection.

Nested Class Summary

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

AbstractWranglerHandler.NamespacedResponder<T>

Constructor Summary

Constructors

Constructor and Description
BigQueryHandler()

Method Summary

Modifier and Type	Method and Description
void	listDatasets(io.cdap.cdap.api.service.http.HttpServiceRequest request, io.cdap.cdap.api.service.http.HttpServiceResponder responder, String namespace, String connectionId)
void	listTables(io.cdap.cdap.api.service.http.HttpServiceRequest request, io.cdap.cdap.api.service.http.HttpServiceResponder responder, String namespace, String connectionId, String datasetStr) List all tables in a dataset.
void	readTable(io.cdap.cdap.api.service.http.HttpServiceRequest request, io.cdap.cdap.api.service.http.HttpServiceResponder responder, String namespace, String connectionId, String datasetStr, String tableId, String scope) Read a table.
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	testBiqQueryConnection(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, initialize, 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

BigQueryHandler

public BigQueryHandler()

Method Detail

testBiqQueryConnection

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

listDatasets

@GET
 @Path(value="/contexts/{context}/connections/{connection-id}/bigquery")
public void listDatasets(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)

listTables

@GET
 @Path(value="contexts/{context}/connections/{connection-id}/bigquery/{dataset-id}/tables")
public void listTables(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="dataset-id")
                                                                                                                        String datasetStr)

List all tables in a dataset.

Parameters:

request - HTTP requests handler.

responder - HTTP response handler.

datasetStr - the dataset id as a string. It will be of the form [project:]name. The project prefix is optional. When not given, the connection project should be used.

readTable

@GET
 @Path(value="contexts/{context}/connections/{connection-id}/bigquery/{dataset-id}/tables/{table-id}/read")
public void readTable(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="dataset-id")
                                                                                                                                       String datasetStr,
                                                                                                                                       @PathParam(value="table-id")
                                                                                                                                       String tableId,
                                                                                                                                       @QueryParam(value="scope") @DefaultValue(value="default")
                                                                                                                                       String scope)

Read a table.

Parameters:

request - HTTP requests handler.

responder - HTTP response handler.

connectionId - Connection Id for BigQuery Service.

datasetStr - id of the dataset on BigQuery.

tableId - id of the BigQuery table.

scope - Group the workspace is created in.

specification

@GET
 @Path(value="contexts/{context}/connections/{connection-id}/bigquery/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.