Package com.yahoo.bard.webservice.web

Interface Summary

Interface	Description
MacroCalculationStrategies	Interface implemented by macros to get the dateTime based on granularity.
MetricsFilterSetBuilder	An interface containing helper methods to build filtered metrics.
RateLimiter	An object containing the logic to keep track of and limit the amount of requests being made to the webservice.
ResponseFormatResolver	A functional interface which allows the logic of resolving response format customizable.
ResponseStream	An interface for classes that transform response data to a format representation (e.g.
ResponseWriter	The interface for objects that write fully-processed ResultSets back to the user.
ResponseWriterSelector	Typically, a Fili program's response writing infrastructure will consist of a collection of unrelated ResponseWriters each responsible for serializing the ResultSet into a specific format, and a single ResponseWriter that chooses the correct one based on the current state of the DataApiRequest.
TableMetadataFormatter	Interface for transforming logical tables into views that are grain-aware.

Class Summary

Class	Description
AbstractResponse<T>	Formats data of a response as JSON.
ApiFilter	ApiFilter object.
ApiHaving	The Bard-level representation of a Druid Having clause.
CsvResponse<T>	Formats data of a response as CSV.
CsvResponseWriter	Serializer for CSV format.
CurrentMacroCalculation	A Class to compute the current DateTime for the current macro.
DataApiRequestTypeIdentifier	Identifies the type of API request (UI, bypass, CORS pre-flight).
DefaultResponseFormatResolver	A Fili default implementation of ResponseFormatResolver.
DimensionApiRequestMapper	Default RequestMapper implementation for DimensionApiRequests.
FiliResponseWriter	Default writer for response.
FiliResponseWriterSelector	FiliResponseWriterSelector is the default selector for ReponseWriterSelector.
FilteredSketchMetricsHelper	Deprecated To consider the latest version of sketch Library.
FilteredThetaSketchMetricsHelper	Class containing helper methods to build filtered metrics.
JsonAndJsonApiResponseWriter	An wrapper for JsonResponseWriter and JsonApiResponseWriter.
JsonApiResponseWriter	Serializer for JsonApi format.
JsonResponse<T>	Formats data of a response as JSON.
JsonResponseWriter	Serializer for Json format.
MetricParser	This class will separate the metrics and associated filters from metricString.
NextMacroCalculation	A Class to compute the current DateTime with the addition of period for the next macro.
NoOpRequestMapper<T extends ApiRequest>	Default RequestMapper implementation.
PreResponse	PreReponse is an encapsulation of ResultSet and ResponseContext.
RequestMapper<T extends ApiRequest>	RequestMapper will do post processing on a given ApiRequest, such as rewriting or validating queries.
ResponseData	ResponseData class.
TableFullViewProcessor	Class to support custom endpoint of the tables with complete view of each table grains and associated metrics & dimensions.
TableGrainView	Type-def for building a response view of a LogicalTable.
TableView	Interface for transforming logical tables into views.

Enum Summary

Enum	Description
DimensionFieldSpecifierKeywords	Keywords for the "show" clause in the API.
ErrorMessageFormat	Common message formats for errors.
FilterOperation	Types of legal filter operations.
HavingOperation	Types of legal having operations.
ResponseCode	Additional HTTP Status Codes not defined in javax.ws.rs.core.Response.Status.
ResponseFormatType	Response format type.
TimeMacro	TimeMacro.

Exception Summary

Exception	Description
BadApiRequestException	Unchecked exception for a bad API request.
BadFilterException	Bad filter exception is an exception encountered when the filter object cannot be built.
BadHavingException	Bad having exception is an exception encountered when the having object cannot be built.
BadPaginationException	Marks that we have experienced a problem with binding and parsing pagination parameters.
JobNotFoundException	Class for exception thrown if a job is not found in the ApiJobStore.
JobRequestFailedException	Unchecked exception in case request to the jobs endpoint fails.
PageNotFoundException	Indicates that a page past the last page of (paginated) results is requested.
RequestValidationException	ApiRequest Validation Failed.
RowLimitReachedException	A request-related or resources-related limit has been reached.

Annotation Types Summary

Annotation Type	Description
ForTesting	Intended to signify that a constructor is defined only for testing purposes.
PATCH	PATCH HTTP method marker for Jersey routing.