io.cdap.wrangler.service.schema

Class DataModelHandler

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.schema.DataModelHandler

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

The DataModelHandler class provides data model schema listings APIs.

Nested Class Summary

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

AbstractWranglerHandler.NamespacedResponder<T>, AbstractWranglerHandler.NamespacedResponderRunnable

Constructor Summary

Constructors

Constructor and Description
DataModelHandler()

Method Summary

Modifier and Type	Method and Description
void	listSchema(io.cdap.cdap.api.service.http.HttpServiceRequest request, io.cdap.cdap.api.service.http.HttpServiceResponder responder, String namespace, String id, long revision) Retrieves the schema of a specific revision of a data model.
void	listSchemas(io.cdap.cdap.api.service.http.HttpServiceRequest request, io.cdap.cdap.api.service.http.HttpServiceResponder responder, String namespace) Returns a list of all data models available.
void	upload(io.cdap.cdap.api.service.http.HttpServiceRequest request, io.cdap.cdap.api.service.http.HttpServiceResponder responder, String namespace) Uploads a one or more data model schemas into the internal data model glossary.

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, 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

DataModelHandler

public DataModelHandler()

Method Detail

upload

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

Uploads a one or more data model schemas into the internal data model glossary. The full name and revision of each data model schema form a unique identify. Returns: 200 - if data model successfully added. 400 - if the request is missing a url parameter in the body. 400 - if the server was unable to load the data model at the specified url.

Parameters:

request - the HTTP request handler.

responder - the HTTP response handler.

namespace - the context of the request.

listSchemas

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

Returns a list of all data models available. By default excludes the data model schemas and only returns the meta data due to potentially large size of the schemas. Returns: 200 - if successful. 404 - if there no data models loaded.

Parameters:

request - the HTTP request handler.

responder - the HTTP response handler.

namespace - the context of the request.

listSchema

@GET
 @Path(value="contexts/{context}/datamodels/schemas/{id}/revisions/{revision}")
public void listSchema(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 id,
                                                                                                            @PathParam(value="revision")
                                                                                                            long revision)

Retrieves the schema of a specific revision of a data model. Returns: 200 - if the appropriate schema version has been located. 404 - if no schema matching the id or version specified exists.

Parameters:

request - the HTTP request handler.

responder - the HTTP response handler.

namespace - the context of the request.

id - of the data model.

revision - of the data model.