Class AbstractPage<RequestT,ResponseT,ResourceT,PageT> (2.66.0)

publicabstractclass AbstractPage<RequestT,ResponseT,ResourceT,PageT>implementsAsyncPage<ResourceT>

Partial implementation of AsyncPage.

Inheritance

java.lang.Object > AbstractPage<RequestT,ResponseT,ResourceT,PageT>

Implements

com.google.api.gax.paging.AsyncPage<ResourceT>

Inherited Members

Object.clone()

Object.equals(Object)

Object.notify()

Object.wait()

Object.wait(long,int)

Type Parameters
Name	Description
`RequestT`
`ResponseT`
`ResourceT`
`PageT`

Constructors

AbstractPage(PageContext<RequestT,ResponseT,ResourceT> context, ResponseT response)

protectedAbstractPage(PageContext<RequestT,ResponseT,ResourceT>context,ResponseTresponse)

Parameters
Name	Description
`context`	`PageContext<RequestT,ResponseT,ResourceT>`
`response`	`ResponseT`

Methods

createPage(PageContext<RequestT,ResponseT,ResourceT> context, ResponseT response)

protectedabstractPageTcreatePage(PageContext<RequestT,ResponseT,ResourceT>context,ResponseTresponse)

Parameters
Name	Description
`context`	`PageContext<RequestT,ResponseT,ResourceT>`
`response`	`ResponseT`

Returns
Type	Description
`PageT`

createPageAsync(PageContext<RequestT,ResponseT,ResourceT> context, ApiFuture<ResponseT> futureResponse)

publicApiFuture<PageT>createPageAsync(PageContext<RequestT,ResponseT,ResourceT>context,ApiFuture<ResponseT>futureResponse)

Parameters
Name	Description
`context`	`PageContext<RequestT,ResponseT,ResourceT>`
`futureResponse`	`ApiFuture<ResponseT>`

Returns
Type	Description
`ApiFuture<PageT>`

getNextPage()

publicPageTgetNextPage()

Retrieves the next Page object using the next page token, or null if there are no more pages. The hasNextPage() method can be used to check if a Page object is available.

Returns
Type	Description
`PageT`

getNextPage(int pageSize)

publicPageTgetNextPage(intpageSize)

Parameter
Name	Description
`pageSize`	`int`

Returns
Type	Description
`PageT`

getNextPageAsync()

publicApiFuture<PageT>getNextPageAsync()

Returns a future for the Page object, retrieved using the next page token. If there are no more pages, returns a future which will immediately provide null. The hasNextPage() method can be used to check if a Page object is available.

Returns
Type	Description
`ApiFuture<PageT>`

getNextPageToken()

publicStringgetNextPageToken()

Returns the next page token from the response, or an empty string if there are no more pages.

Returns
Type	Description
`String`

getPageElementCount()

publicintgetPageElementCount()

Returns
Type	Description
`int`

getRequest()

publicRequestTgetRequest()

Returns
Type	Description
`RequestT`

getResponse()

publicResponseTgetResponse()

Returns
Type	Description
`ResponseT`

getValues()

publicIterable<ResourceT>getValues()

Returns an iterable over the elements in this page.

Returns
Type	Description
`Iterable<ResourceT>`

hasNextPage()

publicbooleanhasNextPage()

Returns true if there are more pages that can be retrieved from the API.

Returns
Type	Description
`boolean`

iterateAll()

publicIterable<ResourceT>iterateAll()

Returns an iterable that traverses all the elements of the underlying data source. The data is fetched lazily page by page, where each page may contain multiple elements. A new page is fetched whenever the elements of any particular page are exhausted.

Returns
Type	Description
`Iterable<ResourceT>`