AI-generated Key Takeaways
-
Paging in list operations returns only one page of results.
-
The
PageInfomessage describes the returned page with fields liketotalResults,resultPerPage, andstartIndex. -
totalResultsindicates the total number of available results,resultPerPageshows the number of results in the current response, andstartIndexis the index of the first result on the page.
Information about the current page.
List operations that supports paging return only one "page" of results. This protocol buffer message describes the page that has been returned.
| JSON representation |
|---|
{ "totalResults": integer, "resultPerPage": integer, "startIndex": integer } |
| Fields | |
|---|---|
totalResults |
Total number of results available on the backend ! The total number of results in the result set. |
resultPerPage |
Maximum number of results returned in one page. ! The number of results included in the API response. |
startIndex |
Index of the first result returned in the current page. |