io.cdap.wrangler.dataset.recipe

Class RecipePageRequest

java.lang.Object

io.cdap.wrangler.dataset.utils.PageRequest<Recipe>

io.cdap.wrangler.dataset.recipe.RecipePageRequest

public class RecipePageRequest
extends PageRequest<Recipe>

Represents a request to fetch a page of Recipes.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RecipePageRequest.Builder Creates a RecipePageRequest object

Field Summary

Fields

Modifier and Type	Field and Description
static String	SORT_BY_NAME
static String	SORT_BY_UPDATE_TIME

Fields inherited from class io.cdap.wrangler.dataset.utils.PageRequest

PAGE_SIZE_DEFAULT, pageSize, pageToken, SORT_ORDER_ASC, SORT_ORDER_DESC, sortBy, sortOrder

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RecipePageRequest(Integer pageSize, String pageToken, String sortBy, String sortOrder, NamespaceSummary namespace)

Method Summary

Modifier and Type	Method and Description
static RecipePageRequest.Builder	builder(NamespaceSummary namespace)
protected String	getDefaultSortBy() Get the default table column name using which results will be sorted.
NamespaceSummary	getNamespace()
String	getNextPageToken(Recipe recipe) Get the nextPageToken returned as part of response to request.
io.cdap.cdap.spi.data.table.field.Range	getScanRange() Constructs the range used to query the storage table.
protected String	getSortByColumnName(String sortBy) Get the table column name mapped to given sortBy value.
void	validateSortBy(String sortBy) Checks whether given sortBy value has a respective table column mapping.

Methods inherited from class io.cdap.wrangler.dataset.utils.PageRequest

getPageSize, getPageToken, getSortBy, getSortOrder, validatePageSize, validateSortOrder

Methods inherited from class java.lang.Object

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

Field Detail

SORT_BY_NAME

public static final String SORT_BY_NAME

See Also:

Constant Field Values

SORT_BY_UPDATE_TIME

public static final String SORT_BY_UPDATE_TIME

See Also:

Constant Field Values

Constructor Detail

RecipePageRequest

protected RecipePageRequest(Integer pageSize,
                            String pageToken,
                            String sortBy,
                            String sortOrder,
                            NamespaceSummary namespace)

Method Detail

getNamespace

public NamespaceSummary getNamespace()

validateSortBy

public void validateSortBy(String sortBy)

Description copied from class: PageRequest

Checks whether given sortBy value has a respective table column mapping.

Specified by:

validateSortBy in class PageRequest<Recipe>

Parameters:

sortBy - field based on which results should be sorted

getDefaultSortBy

protected String getDefaultSortBy()

Description copied from class: PageRequest

Get the default table column name using which results will be sorted.

Specified by:

getDefaultSortBy in class PageRequest<Recipe>

getSortByColumnName

protected String getSortByColumnName(String sortBy)

Description copied from class: PageRequest

Get the table column name mapped to given sortBy value.

Specified by:

getSortByColumnName in class PageRequest<Recipe>

getScanRange

public io.cdap.cdap.spi.data.table.field.Range getScanRange()

Description copied from class: PageRequest

Constructs the range used to query the storage table.

Specified by:

getScanRange in class PageRequest<Recipe>

Returns:

Range corresponding to page query parameters.

getNextPageToken

public String getNextPageToken(Recipe recipe)

Description copied from class: PageRequest

Get the nextPageToken returned as part of response to request.

Specified by:

getNextPageToken in class PageRequest<Recipe>

Parameters:

recipe - resource returned by the request

builder

public static RecipePageRequest.Builder builder(NamespaceSummary namespace)