com.yahoo.bard.webservice.web.apirequest

Interface ApiRequest

All Known Subinterfaces:

DataApiRequest, DimensionsApiRequest, JobsApiRequest, MetricsApiRequest, SlicesApiRequest, TablesApiRequest

All Known Implementing Classes:

ApiRequestImpl, DataApiRequestImpl, DimensionsApiRequestImpl, JobsApiRequestImpl, MetricsApiRequestImpl, SlicesApiRequestImpl, TablesApiRequestImpl

public interface ApiRequest

Interface offering default implementations for the common components of API request objects.

Field Summary

Fields

Modifier and Type	Field and Description
static long	ASYNCHRONOUS_ASYNC_AFTER_VALUE
static long	SYNCHRONOUS_ASYNC_AFTER_VALUE

Method Summary

Modifier and Type	Method and Description
default org.joda.time.format.DateTimeFormatter	generateDateTimeFormatter(org.joda.time.DateTimeZone timeZone) Get the DateTimeFormatter shifted to the given time zone.
long	getAsyncAfter() Returns how long the user is willing to wait before a request should go asynchronous.
javax.ws.rs.core.Response.ResponseBuilder	getBuilder() Get the response builder associated with this request.
PaginationParameters	getDefaultPagination() Get the default pagination parameters for this type of API request.
ResponseFormatType	getFormat() Get the type of the requested response format.
<T> Stream<T>	getPage(Collection<T> data) Deprecated. Pagination is moving to a Stream and pushing creation of the page to a more general method (getPage(Pagination)) to allow for more flexibility in how pagination is done.
<T> Stream<T>	getPage(Pagination<T> pagination) Add links to the response builder and return a stream with the requested page from the raw data.
Pagination<?>	getPagination() Get the pagination object associated with this request.
Optional<PaginationParameters>	getPaginationParameters() Get the requested pagination parameters.
javax.ws.rs.core.UriInfo	getUriInfo() Get the uri info.

Field Detail

SYNCHRONOUS_ASYNC_AFTER_VALUE

static final long SYNCHRONOUS_ASYNC_AFTER_VALUE

See Also:

Constant Field Values

ASYNCHRONOUS_ASYNC_AFTER_VALUE

static final long ASYNCHRONOUS_ASYNC_AFTER_VALUE

See Also:

Constant Field Values

Method Detail

generateDateTimeFormatter

default org.joda.time.format.DateTimeFormatter generateDateTimeFormatter(org.joda.time.DateTimeZone timeZone)

Get the DateTimeFormatter shifted to the given time zone.

Parameters:

timeZone - TimeZone to shift the default formatter to

Returns:

the timezone-shifted formatter

getFormat

ResponseFormatType getFormat()

Get the type of the requested response format.

Returns:

The format of the response for this API request.

getPaginationParameters

Optional<PaginationParameters> getPaginationParameters()

Get the requested pagination parameters.

Returns:

The pagination parameters for this API request

getUriInfo

javax.ws.rs.core.UriInfo getUriInfo()

Get the uri info.

Returns:

The uri info of this API request

getPagination

Pagination<?> getPagination()

Get the pagination object associated with this request. This object has valid contents after a call to getPage(java.util.Collection<T>)

Returns:

The pagination object.

getAsyncAfter

long getAsyncAfter()

Returns how long the user is willing to wait before a request should go asynchronous.

Returns:

The maximum number of milliseconds the request is allowed to take before going from synchronous to asynchronous

getBuilder

javax.ws.rs.core.Response.ResponseBuilder getBuilder()

Get the response builder associated with this request.

Returns:

The response builder.

getDefaultPagination

PaginationParameters getDefaultPagination()

Get the default pagination parameters for this type of API request.

Returns:

The uri info of this type of API request

getPage

@Deprecated
<T> Stream<T> getPage(Collection<T> data)

Deprecated. Pagination is moving to a Stream and pushing creation of the page to a more general method (getPage(Pagination)) to allow for more flexibility in how pagination is done.

Add links to the response builder and return a stream with the requested page from the raw data.

Type Parameters:

T - The type of the collection elements

Parameters:

data - The data to be paginated.

Returns:

A stream corresponding to the requested page.

getPage

<T> Stream<T> getPage(Pagination<T> pagination)

Add links to the response builder and return a stream with the requested page from the raw data.

Type Parameters:

T - The type of the collection elements

Parameters:

pagination - The pagination object

Returns:

A stream corresponding to the requested page.