org.brapi.v2.model

Class BrAPISearchRequestParametersTokenPaging

java.lang.Object

org.brapi.v2.model.BrAPISearchRequestParametersPaging

org.brapi.v2.model.BrAPISearchRequestParametersTokenPaging

Direct Known Subclasses:

BrAPICallsSearchRequest, BrAPIVariantsSearchRequest

public class BrAPISearchRequestParametersTokenPaging
extends BrAPISearchRequestParametersPaging

SearchRequestParametersTokenPaging

Constructor Summary

Constructors

Constructor and Description
BrAPISearchRequestParametersTokenPaging()

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
String	getPageToken() Used to request a specific page of data to be returned.
int	hashCode()
BrAPISearchRequestParametersTokenPaging	pageSize(Integer pageSize)
BrAPISearchRequestParametersTokenPaging	pageToken(String pageToken) The size of the pages to be returned.
void	setPageToken(String pageToken)
String	toString()

Methods inherited from class org.brapi.v2.model.BrAPISearchRequestParametersPaging

getPage, getPageSize, page, setPage, setPageSize

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

BrAPISearchRequestParametersTokenPaging

public BrAPISearchRequestParametersTokenPaging()

Method Detail

pageSize

public BrAPISearchRequestParametersTokenPaging pageSize(Integer pageSize)

Overrides:

pageSize in class BrAPISearchRequestParametersPaging

pageToken

public BrAPISearchRequestParametersTokenPaging pageToken(String pageToken)

The size of the pages to be returned. Default is `1000`.

Returns:

pageSize

getPageToken

public String getPageToken()

Used to request a specific page of data to be returned. Tokenized pages are for large data sets which can not be efficiently broken into indexed pages. Use the nextPageToken and prevPageToken from a prior response to construct a query and move to the next or previous page respectively.

Returns:

pageToken

setPageToken

public void setPageToken(String pageToken)

equals

public boolean equals(Object o)

Overrides:

equals in class BrAPISearchRequestParametersPaging

hashCode

public int hashCode()

Overrides:

hashCode in class BrAPISearchRequestParametersPaging

toString

public String toString()

Overrides:

toString in class BrAPISearchRequestParametersPaging