Interface Page<ResourceT> (2.72.2)
- 2.72.2 (latest)
- 2.72.1
- 2.71.0
- 2.70.3
- 2.69.0
- 2.68.2
- 2.67.0
- 2.66.0
- 2.65.0
- 2.63.1
- 2.62.0
- 2.61.0
- 2.60.0
- 2.59.1
- 2.58.0
- 2.57.0
- 2.55.0
- 2.54.1
- 2.53.0
- 2.52.0
- 2.51.0
- 2.50.0
- 2.49.0
- 2.48.1
- 2.47.0
- 2.46.1
- 2.45.0
- 2.43.0
- 2.42.0
- 2.41.0
- 2.39.0
- 2.38.0
- 2.37.0
- 2.36.0
- 2.35.0
- 2.34.1
- 2.33.0
- 2.32.1
- 2.31.1
- 2.30.1
- 2.24.0
- 2.23.3
- 2.22.0
- 2.21.0
- 2.20.1
- 2.19.6
- 2.18.7
- 2.17.0
- 2.16.0
- 2.15.0
- 2.14.0
- 2.13.0
- 2.12.2
- 2.11.0
- 2.10.0
- 2.9.0
- 2.8.1
- 2.7.1
publicinterfacePage<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()
publicabstractPage<ResourceT>getNextPage()Retrieves the next Page object using the next page token, ornull 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()
publicabstractStringgetNextPageToken()Returns the next page token from the response, or an empty string if there are no more pages.
| Returns | |
|---|---|
| Type | Description |
String | |
getValues()
publicabstractIterable<ResourceT>getValues()Returns an iterable over the elements in this page.
| Returns | |
|---|---|
| Type | Description |
Iterable<ResourceT> | |
hasNextPage()
publicabstractbooleanhasNextPage()Returns true if there are more pages that can be retrieved from the API.
| Returns | |
|---|---|
| Type | Description |
boolean | |
iterateAll()
publicabstractIterable<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()
publicdefaultStream<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()
publicdefaultStream<ResourceT>streamValues()Returns a stream over the elements in this page.
| Returns | |
|---|---|
| Type | Description |
Stream<ResourceT> | |
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-12-17 UTC.