co.cask.cdap.dq

Class DataQualityService.ValuesLookup

java.lang.Object

co.cask.cdap.internal.api.AbstractProgramDatasetConfigurable

co.cask.cdap.internal.api.AbstractPluginConfigurable<HttpServiceConfigurer>

co.cask.cdap.api.service.http.AbstractHttpServiceHandler

co.cask.cdap.dq.DataQualityService.ValuesLookup

All Implemented Interfaces:

HttpServiceHandler

Enclosing class:

DataQualityService

@Path(value="/v1")
public static final class DataQualityService.ValuesLookup
extends AbstractHttpServiceHandler

Handler class for Data Quality Combinable Aggregations Service

Constructor Summary

Constructors

Constructor and Description
DataQualityService.ValuesLookup(String datasetName)

Method Summary

Methods

Modifier and Type	Method and Description
void	aggregationTypesGetter(HttpServiceRequest request, HttpServiceResponder responder, String fieldName, String sourceID, long startTimestamp, long endTimestamp) Gets the aggregation functions that are queryable for a given time range, sourceID, and field name
void	basicAggregationGetter(HttpServiceRequest request, HttpServiceResponder responder, String fieldName, String aggregationType, String sourceID, long startTimestamp, long endTimestamp) Gets the corresponding aggregation for a given aggregation type, field name, sourceID, and time interval
void	combinableAggregationGetter(HttpServiceRequest request, HttpServiceResponder responder, String fieldName, String aggregationType, String sourceID, long startTimestamp, long endTimestamp) Gets the corresponding aggregation for a given aggregation type, field name, sourceID, and time interval
protected void	configure()
void	fieldsGetter(HttpServiceRequest request, HttpServiceResponder responder, String sourceID, long startTimestamp, long endTimestamp) Gets the fields that are queryable for a given time range and sourceID for combinable aggregation functions
void	initialize(HttpServiceContext context)

Methods inherited from class co.cask.cdap.api.service.http.AbstractHttpServiceHandler

configure, destroy, getConfigurer, getContext, setProperties, useDatasets, useDatasets

Methods inherited from class co.cask.cdap.internal.api.AbstractPluginConfigurable

usePlugin, usePlugin, usePluginClass, usePluginClass

Methods inherited from class co.cask.cdap.internal.api.AbstractProgramDatasetConfigurable

addDatasetModule, addDatasetType, addStream, addStream, createDataset, createDataset, createDataset, createDataset

Methods inherited from class java.lang.Object

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

Constructor Detail

DataQualityService.ValuesLookup

public DataQualityService.ValuesLookup(String datasetName)

Method Detail

configure

protected void configure()

Overrides:

configure in class AbstractHttpServiceHandler

initialize

public void initialize(HttpServiceContext context)
                throws Exception

Specified by:

initialize in interface HttpServiceHandler

Overrides:

initialize in class AbstractHttpServiceHandler

Throws:

Exception

fieldsGetter

@Path(value="sources/{sourceID}/fields")
@GET
public void fieldsGetter(HttpServiceRequest request,
                              HttpServiceResponder responder,
                              @PathParam(value="sourceID")
                              String sourceID,
                              @QueryParam(value="startTimestamp")@DefaultValue(value="0")
                              long startTimestamp,
                              @QueryParam(value="endTimestamp")@DefaultValue(value="9223372036854775807")
                              long endTimestamp)
                  throws IOException

Gets the fields that are queryable for a given time range and sourceID for combinable aggregation functions

Throws:

IOException

aggregationTypesGetter

@Path(value="sources/{sourceID}/fields/{fieldName}")
@GET
public void aggregationTypesGetter(HttpServiceRequest request,
                                        HttpServiceResponder responder,
                                        @PathParam(value="fieldName")
                                        String fieldName,
                                        @PathParam(value="sourceID")
                                        String sourceID,
                                        @QueryParam(value="startTimestamp")@DefaultValue(value="0")
                                        long startTimestamp,
                                        @QueryParam(value="endTimestamp")@DefaultValue(value="9223372036854775807")
                                        long endTimestamp)
                            throws IOException

Gets the aggregation functions that are queryable for a given time range, sourceID, and field name

Throws:

IOException

combinableAggregationGetter

@Path(value="sources/{sourceID}/fields/{fieldName}/aggregations/{aggregationType}/totals")
@GET
public void combinableAggregationGetter(HttpServiceRequest request,
                                             HttpServiceResponder responder,
                                             @PathParam(value="fieldName")
                                             String fieldName,
                                             @PathParam(value="aggregationType")
                                             String aggregationType,
                                             @PathParam(value="sourceID")
                                             String sourceID,
                                             @QueryParam(value="startTimestamp")@DefaultValue(value="0")
                                             long startTimestamp,
                                             @QueryParam(value="endTimestamp")@DefaultValue(value="9223372036854775807")
                                             long endTimestamp)
                                 throws IOException

Gets the corresponding aggregation for a given aggregation type, field name, sourceID, and time interval

Throws:

IOException

basicAggregationGetter

@Path(value="sources/{sourceID}/fields/{fieldName}/aggregations/{aggregationType}/timeseries")
@GET
public void basicAggregationGetter(HttpServiceRequest request,
                                        HttpServiceResponder responder,
                                        @PathParam(value="fieldName")
                                        String fieldName,
                                        @PathParam(value="aggregationType")
                                        String aggregationType,
                                        @PathParam(value="sourceID")
                                        String sourceID,
                                        @QueryParam(value="startTimestamp")@DefaultValue(value="0")
                                        long startTimestamp,
                                        @QueryParam(value="endTimestamp")@DefaultValue(value="9223372036854775807")
                                        long endTimestamp)
                            throws IOException

Gets the corresponding aggregation for a given aggregation type, field name, sourceID, and time interval

Throws:

IOException