com.yahoo.bard.webservice.web.apirequest

Interface TablesApiRequest

All Superinterfaces:

ApiRequest

All Known Implementing Classes:

TablesApiRequestImpl

public interface TablesApiRequest
extends ApiRequest

Tables API Request. Such an API Request binds, validates, and models the parts of a request to the tables endpoint.

Field Summary

Fields

Modifier and Type	Field and Description
static String	REQUEST_MAPPER_NAMESPACE

Fields inherited from interface com.yahoo.bard.webservice.web.apirequest.ApiRequest

ASYNCHRONOUS_ASYNC_AFTER_VALUE, SYNCHRONOUS_ASYNC_AFTER_VALUE

Method Summary

Modifier and Type	Method and Description
ApiFilters	getApiFilters() Returns a map of filters by dimension for this request, grouped by dimensions.
Set<Dimension>	getDimensions() Returns the set of grouping dimensions on this request.
Set<Dimension>	getFilterDimensions() Returns the dimensions used in filters on this request.
Granularity	getGranularity() Returns the grain to group the results of this request.
Set<org.joda.time.Interval>	getIntervals() Returns the intervals for this query.
Set<LogicalMetric>	getLogicalMetrics() Returns the logical metrics requested in this query.
LogicalTable	getTable() Returns the LogicalTable requested in the table API request URL.
Set<LogicalTable>	getTables() Returns a set of LogicalTables associated with a table API request.
TablesApiRequest	withBuilder(javax.ws.rs.core.Response.ResponseBuilder builder)
TablesApiRequest	withDimensions(Set<Dimension> dimensions)
TablesApiRequest	withFilters(Map<Dimension,Set<ApiFilter>> filters)
TablesApiRequest	withFormat(ResponseFormatType format)
TablesApiRequest	withGranularity(Set<LogicalTable> tables)
TablesApiRequest	withIntervals(Set<org.joda.time.Interval> intervals)
TablesApiRequest	withMetrics(Set<LogicalMetric> metrics)
TablesApiRequest	withPaginationParameters(Optional<PaginationParameters> paginationParameters)
TablesApiRequest	withTable(LogicalTable table)
TablesApiRequest	withTables(Granularity granularity)
TablesApiRequest	withTables(Set<LogicalTable> tables)
TablesApiRequest	withUriInfo(javax.ws.rs.core.UriInfo uriInfo)

Methods inherited from interface com.yahoo.bard.webservice.web.apirequest.ApiRequest

generateDateTimeFormatter, getAsyncAfter, getBuilder, getDefaultPagination, getFormat, getPage, getPage, getPagination, getPaginationParameters, getUriInfo

Field Detail

REQUEST_MAPPER_NAMESPACE

static final String REQUEST_MAPPER_NAMESPACE

See Also:

Constant Field Values

Method Detail

getTables

Set<LogicalTable> getTables()

Returns a set of LogicalTables associated with a table API request.

Returns:

the set of LogicalTables associated with a table API request

getTable

LogicalTable getTable()

Returns the LogicalTable requested in the table API request URL.

Returns:

the LogicalTable requested in the table API request URL

getGranularity

Granularity getGranularity()

Returns the grain to group the results of this request.

Returns:

the grain to group the results of this request

getDimensions

Set<Dimension> getDimensions()

Returns the set of grouping dimensions on this request.

Returns:

the set of grouping dimensions on this request

getFilterDimensions

Set<Dimension> getFilterDimensions()

Returns the dimensions used in filters on this request.

Returns:

the dimensions used in filters on this request

getApiFilters

ApiFilters getApiFilters()

Returns a map of filters by dimension for this request, grouped by dimensions.

Returns:

the map of filters by dimension for this request, grouped by dimensions

getIntervals

Set<org.joda.time.Interval> getIntervals()

Returns the intervals for this query.

Returns:

the intervals for this query

getLogicalMetrics

Set<LogicalMetric> getLogicalMetrics()

Returns the logical metrics requested in this query.

Returns:

the logical metrics requested in this query

withFormat

TablesApiRequest withFormat(ResponseFormatType format)

withPaginationParameters

TablesApiRequest withPaginationParameters(Optional<PaginationParameters> paginationParameters)

withUriInfo

TablesApiRequest withUriInfo(javax.ws.rs.core.UriInfo uriInfo)

withBuilder

TablesApiRequest withBuilder(javax.ws.rs.core.Response.ResponseBuilder builder)

withTables

TablesApiRequest withTables(Set<LogicalTable> tables)

withTable

TablesApiRequest withTable(LogicalTable table)

withGranularity

TablesApiRequest withGranularity(Set<LogicalTable> tables)

withTables

TablesApiRequest withTables(Granularity granularity)

withDimensions

TablesApiRequest withDimensions(Set<Dimension> dimensions)

withMetrics

TablesApiRequest withMetrics(Set<LogicalMetric> metrics)

withIntervals

TablesApiRequest withIntervals(Set<org.joda.time.Interval> intervals)

withFilters

TablesApiRequest withFilters(Map<Dimension,Set<ApiFilter>> filters)