AI-generated Key Takeaways
-
This document explains the structure of pagination information returned for list operations that support paging when token pagination is enabled.
-
Clients should utilize the
nextPageToken
orpreviousPageToken
to navigate between pages of results. -
The presence or absence of these tokens indicates the availability of additional pages.
-
The JSON representation of this pagination information includes
nextPageToken
andpreviousPageToken
fields as strings.
Pagination information returned by a List operation when token pagination is enabled.
List operations that supports paging return only one "page" of results. This protocol buffer message describes the page that has been returned.
When using token pagination, clients should use the next/previous token to get another page of the result. The presence or absence of next/previous token indicates whether a next/previous page is available and provides a mean of accessing this page. ListRequest.page_token should be set to either nextPageToken or previousPageToken to access another page.
JSON representation |
---|
{ "nextPageToken": string, "previousPageToken": string } |
Fields | |
---|---|
nextPageToken |
Tokens to pass to the standard list field 'pageToken'. Whenever available, tokens are preferred over manipulating startIndex. |
previousPageToken |
|