public interface Page<ResourceT>A Page object wraps an API list method response.
Callers can iterate over the Page object to get all elements returned in the page. The Page object also provides methods to retrieve additional pages using the page token, and to get the API request and response objects.
Type Parameter | |
|---|---|
| Name | Description |
ResourceT | |
Methods
getNextPage()
public abstract Page<ResourceT> 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 | |
|---|---|
| Type | Description |
Page<ResourceT> | |
getNextPageToken()
public abstract String getNextPageToken()Returns the next page token from the response, or an empty string if there are no more pages.
| Returns | |
|---|---|
| Type | Description |
String | |
getValues()
public abstract Iterable<ResourceT> getValues()Returns an iterable over the elements in this page.
| Returns | |
|---|---|
| Type | Description |
Iterable<ResourceT> | |
hasNextPage()
public abstract boolean hasNextPage()Returns true if there are more pages that can be retrieved from the API.
| Returns | |
|---|---|
| Type | Description |
boolean | |
iterateAll()
public abstract Iterable<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> | |
streamAll()
public default Stream<ResourceT> streamAll()Returns a stream 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 |
Stream<ResourceT> | |
streamValues()
public default Stream<ResourceT> streamValues()Returns a stream over the elements in this page.
| Returns | |
|---|---|
| Type | Description |
Stream<ResourceT> | |