com.yahoo.bard.webservice.web.apirequest

Class JobsApiRequestImpl

java.lang.Object

com.yahoo.bard.webservice.web.apirequest.ApiRequestImpl

com.yahoo.bard.webservice.web.apirequest.JobsApiRequestImpl

All Implemented Interfaces:

ApiRequest, JobsApiRequest

public class JobsApiRequestImpl
extends ApiRequestImpl
implements JobsApiRequest

Jobs API Request Implementation binds, validates, and models the parts of a request to the jobs endpoint.

Field Summary

Fields inherited from class com.yahoo.bard.webservice.web.apirequest.ApiRequestImpl

asyncAfter, builder, COMMA_AFTER_BRACKET_PATTERN, format, pagination, paginationParameters, uriInfo

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

REQUEST_MAPPER_NAMESPACE

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

ASYNCHRONOUS_ASYNC_AFTER_VALUE, SYNCHRONOUS_ASYNC_AFTER_VALUE

Constructor Summary

Constructors

Constructor and Description
JobsApiRequestImpl(String format, String asyncAfter, String perPage, String page, String filters, javax.ws.rs.core.UriInfo uriInfo, JobPayloadBuilder jobPayloadBuilder, ApiJobStore apiJobStore) Parses the API request URL and generates the Api Request object.

Method Summary

Modifier and Type	Method and Description
LinkedHashSet<JobRowFilter>	buildJobStoreFilter(String filterQuery) Given a filter String, generates a Set of ApiJobStoreFilters.
rx.Observable<Map<String,String>>	getJobViewObservable(String ticket) Returns an Observable over the Map representing the job to be returned to the user.
rx.Observable<Map<String,String>>	getJobViews() Return an Observable containing a stream of job views for jobs in the ApiJobStore.

Methods inherited from class com.yahoo.bard.webservice.web.apirequest.ApiRequestImpl

addPageLink, addPageLink, generateAcceptFormat, generateAsyncAfter, generateDimensions, generateFilters, generateGranularity, generateGranularity, generateIntervals, generateIntervals, generateLogicalMetrics, generateMetricName, generatePaginationParameters, generateTable, generateTimeZone, getAllPagesPaginationFactory, getAsDateTime, getAsyncAfter, getBuilder, getDefaultPagination, getFormat, getPage, getPage, getPagination, getPaginationParameters, getUriInfo, validateMetrics, validateRequestDimensions, validateTimeAlignment

Methods inherited from class java.lang.Object

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

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

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

Constructor Detail

JobsApiRequestImpl

public JobsApiRequestImpl(String format,
                          String asyncAfter,
                          @NotNull
                          String perPage,
                          @NotNull
                          String page,
                          String filters,
                          javax.ws.rs.core.UriInfo uriInfo,
                          JobPayloadBuilder jobPayloadBuilder,
                          ApiJobStore apiJobStore)

Parses the API request URL and generates the Api Request object.

Parameters:

format - response data format JSON or CSV. Default is JSON.

asyncAfter - How long the user is willing to wait for a synchronous request in milliseconds

perPage - number of rows to display per page of results. If present in the original request, must be a positive integer. If not present, must be the empty string.

page - desired page of results. If present in the original request, must be a positive integer. If not present, must be the empty string.

filters - URL filter query String in the format:

 ((field name and operation):((multiple values bounded by [])or(single value))))(followed by , or end of string)
 

uriInfo - The URI of the request object.

jobPayloadBuilder - The JobRowMapper to be used to map JobRow to the Job returned by the api

apiJobStore - The ApiJobStore containing Job metadata

Method Detail

getJobViewObservable

public rx.Observable<Map<String,String>> getJobViewObservable(String ticket)

Returns an Observable over the Map representing the job to be returned to the user.

Parameters:

ticket - The ticket that uniquely identifies the job

Returns:

An Observable over the Map representing the job to be returned to the user or an Observable wrapping JobNotFoundException if the Job is not available in the ApiJobStore

getJobViews

public rx.Observable<Map<String,String>> getJobViews()

Return an Observable containing a stream of job views for jobs in the ApiJobStore. If filter String is non null and non empty, only return results that satisfy the filter. If filter String is null or empty, return all rows. If, for any JobRow, the mapping from JobRow to job view fails, an Observable over JobRequestFailedException is returned. If the ApiJobStore is empty, we return an empty Observable.

Returns:

An Observable containing a stream of Maps representing the job to be returned to the user

buildJobStoreFilter

public LinkedHashSet<JobRowFilter> buildJobStoreFilter(@NotNull
                                                       String filterQuery)

Given a filter String, generates a Set of ApiJobStoreFilters. This method will throw a BadApiRequestException if the filter String cannot be parsed into ApiJobStoreFilters successfully.

Parameters:

filterQuery - Expects a URL filterQuery String that may contain multiple filters separated by comma. The format of a filter String is : (JobField name)-(operation)[(value or comma separated values)]?

Returns:

A Set of ApiJobStoreFilters