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

Stay organized with collections Save and categorize content based on your preferences.
public abstract class AbstractPage<RequestT,ResponseT,ResourceT,PageT> implements AsyncPage<ResourceT>

Partial implementation of AsyncPage.

Inheritance

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

Implements

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

Type Parameters

NameDescription
RequestT
ResponseT
ResourceT
PageT

Constructors

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

protected AbstractPage(PageContext<RequestT,ResponseT,ResourceT> context, ResponseT response)
Parameters
NameDescription
contextPageContext<RequestT,ResponseT,ResourceT>
responseResponseT

Methods

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

protected abstract PageT createPage(PageContext<RequestT,ResponseT,ResourceT> context, ResponseT response)
Parameters
NameDescription
contextPageContext<RequestT,ResponseT,ResourceT>
responseResponseT
Returns
TypeDescription
PageT

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

public ApiFuture<PageT> createPageAsync(PageContext<RequestT,ResponseT,ResourceT> context, ApiFuture<ResponseT> futureResponse)
Parameters
NameDescription
contextPageContext<RequestT,ResponseT,ResourceT>
futureResponsecom.google.api.core.ApiFuture<ResponseT>
Returns
TypeDescription
com.google.api.core.ApiFuture<PageT>

getNextPage()

public PageT getNextPage()

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
TypeDescription
PageT

getNextPage(int pageSize)

public PageT getNextPage(int pageSize)
Parameter
NameDescription
pageSizeint
Returns
TypeDescription
PageT

getNextPageAsync()

public ApiFuture<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
TypeDescription
com.google.api.core.ApiFuture<PageT>

getNextPageToken()

public String getNextPageToken()

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

Returns
TypeDescription
String

getPageElementCount()

public int getPageElementCount()
Returns
TypeDescription
int

getRequest()

public RequestT getRequest()
Returns
TypeDescription
RequestT

getResponse()

public ResponseT getResponse()
Returns
TypeDescription
ResponseT

getValues()

public Iterable<ResourceT> getValues()

Returns an iterable over the elements in this page.

Returns
TypeDescription
Iterable<ResourceT>

hasNextPage()

public boolean hasNextPage()

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

Returns
TypeDescription
boolean

iterateAll()

public Iterable<ResourceT> iterateAll()

Returns an iterable that traverses all of 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
TypeDescription
Iterable<ResourceT>