Package com.smartsheet.api.models

Class PaginationParameters.PaginationParametersBuilder

java.lang.Object

com.smartsheet.api.models.PaginationParameters.PaginationParametersBuilder

Enclosing class:

PaginationParameters

public static class PaginationParameters.PaginationParametersBuilder
extends java.lang.Object

A convenience class for creating a PaginationParameters object

Constructor Summary

Constructors

Constructor	Description
PaginationParametersBuilder()

Method Summary

Modifier and Type	Method	Description
PaginationParameters	build()	Builds the PaginationParameters object
java.lang.String	getLastKey()	Gets the lastKey
java.lang.Integer	getMaxItems()	Gets the maxItems
java.lang.Integer	getPage()	Gets the page
java.lang.Integer	getPageSize()	Gets the page size
java.lang.String	getPaginationType()	Gets the pagination type
boolean	isIncludeAll()	Gets the include all flag
PaginationParameters.PaginationParametersBuilder	setIncludeAll(boolean includeAll)	Sets the include All Flag
PaginationParameters.PaginationParametersBuilder	setLastKey(java.lang.String lastKey)	Sets the lastKey
PaginationParameters.PaginationParametersBuilder	setMaxItems(java.lang.Integer maxItems)	Sets the maxItems
PaginationParameters.PaginationParametersBuilder	setPage(java.lang.Integer page)	Sets the page
PaginationParameters.PaginationParametersBuilder	setPageSize(java.lang.Integer pageSize)	Sets the page size
PaginationParameters.PaginationParametersBuilder	setPaginationType(java.lang.String paginationType)	Sets the pagination type

Methods inherited from class java.lang.Object

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

Constructor Detail

PaginationParametersBuilder

public PaginationParametersBuilder()

Method Detail

isIncludeAll

public boolean isIncludeAll()

Gets the include all flag

Returns:

the include all flag

setIncludeAll

public PaginationParameters.PaginationParametersBuilder setIncludeAll(boolean includeAll)

Sets the include All Flag

Parameters:

includeAll - the include all flag

Returns:

the builder

getPage

public java.lang.Integer getPage()

Gets the page

Returns:

the page

setPage

public PaginationParameters.PaginationParametersBuilder setPage(java.lang.Integer page)

Sets the page

Parameters:

page - the page

Returns:

the builder

getPageSize

public java.lang.Integer getPageSize()

Gets the page size

Returns:

the page size

setPageSize

public PaginationParameters.PaginationParametersBuilder setPageSize(java.lang.Integer pageSize)

Sets the page size

Parameters:

pageSize - the page size

Returns:

the builder

getPaginationType

public java.lang.String getPaginationType()

Gets the pagination type

Returns:

the pagination type

setPaginationType

public PaginationParameters.PaginationParametersBuilder setPaginationType(java.lang.String paginationType)

Sets the pagination type

Parameters:

paginationType - the pagination type (e.g. "token")

Returns:

the builder

getLastKey

public java.lang.String getLastKey()

Gets the lastKey

Returns:

the lastKey

setLastKey

public PaginationParameters.PaginationParametersBuilder setLastKey(java.lang.String lastKey)

Sets the lastKey

Parameters:

lastKey - the lastKey for token-based pagination

Returns:

the builder

getMaxItems

public java.lang.Integer getMaxItems()

Gets the maxItems

Returns:

the maxItems

setMaxItems

public PaginationParameters.PaginationParametersBuilder setMaxItems(java.lang.Integer maxItems)

Sets the maxItems

Parameters:

maxItems - the maxItems for token-based pagination

Returns:

the builder

build

public PaginationParameters build()

Builds the PaginationParameters object

Returns:

pagination parameter object