TokenPagination

  • Token pagination is used by List operations supporting paging to return a single page of results.

  • Clients should use nextPageToken or previousPageToken to access additional pages of results.

  • The presence or absence of nextPageToken or previousPageToken indicates the availability of further pages.

  • When available, nextPageToken is preferred over manipulating startIndex.

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

string

Tokens to pass to the standard list field 'pageToken'. Whenever available, tokens are preferred over manipulating startIndex.

previousPageToken

string