This class is used to access the results of a paged list API method. The management of page
tokens can be handled automatically, or by the caller. Results can be accessed on a per-element
or per-page basis.
Returns a collection of elements with a fixed size set by the collectionSize parameter. The
collection will only contain fewer than collectionSize elements if there are no more pages to
be retrieved from the server.
NOTE: it is an error to call this method if the optional parameter 'page_size' has not been
set in the original API call. It is also an error if the collectionSize parameter is less than
the page_size.
Returns an iterable that traverses all of 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. This method is not
thread-safe.
Returns an iterable over fixed size collections of results. The collections are retrieved
lazily from the underlying API.
Each collection will have collectionSize elements, with the exception of the final
collection which may contain fewer elements.
NOTE: it is an error to call this method if the optional parameter 'page_size' has not been
set in the original API call. It is also an error if the collectionSize parameter is less than
the page_size.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[[["\u003cp\u003eThis webpage provides documentation for the \u003ccode\u003ePagedListResponse\u003c/code\u003e interface in the Google API Client Library for Java, specifically within the \u003ccode\u003ecom.google.api.gax.paging\u003c/code\u003e package.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003ePagedListResponse\u003c/code\u003e interface is designed for handling paged results from list API methods, offering methods to access results on a per-element or per-page basis.\u003c/p\u003e\n"],["\u003cp\u003eThe page offers access to different versions of the api, ranging from version 2.7.1 to the latest version 2.63.1, to the API interface, to allow users to review past versions.\u003c/p\u003e\n"],["\u003cp\u003eKey methods include \u003ccode\u003eexpandToFixedSizeCollection\u003c/code\u003e, \u003ccode\u003egetNextPageToken\u003c/code\u003e, \u003ccode\u003egetPage\u003c/code\u003e, \u003ccode\u003eiterateAll\u003c/code\u003e, \u003ccode\u003eiterateFixedSizeCollections\u003c/code\u003e, and \u003ccode\u003eiteratePages\u003c/code\u003e, providing various ways to interact with paged data.\u003c/p\u003e\n"],["\u003cp\u003eThe interface supports lazy loading of data, fetching pages or elements as needed, and it's not thread-safe, requiring careful management in multi-threaded environments.\u003c/p\u003e\n"]]],[],null,["# Interface PagedListResponse<ResourceT> (2.69.0)\n\nVersion latestkeyboard_arrow_down\n\n- [2.69.0 (latest)](/java/docs/reference/gax/latest/com.google.api.gax.paging.PagedListResponse)\n- [2.68.2](/java/docs/reference/gax/2.68.2/com.google.api.gax.paging.PagedListResponse)\n- [2.67.0](/java/docs/reference/gax/2.67.0/com.google.api.gax.paging.PagedListResponse)\n- [2.66.0](/java/docs/reference/gax/2.66.0/com.google.api.gax.paging.PagedListResponse)\n- [2.65.0](/java/docs/reference/gax/2.65.0/com.google.api.gax.paging.PagedListResponse)\n- [2.63.1](/java/docs/reference/gax/2.63.1/com.google.api.gax.paging.PagedListResponse)\n- [2.62.0](/java/docs/reference/gax/2.62.0/com.google.api.gax.paging.PagedListResponse)\n- [2.61.0](/java/docs/reference/gax/2.61.0/com.google.api.gax.paging.PagedListResponse)\n- [2.60.0](/java/docs/reference/gax/2.60.0/com.google.api.gax.paging.PagedListResponse)\n- [2.59.1](/java/docs/reference/gax/2.59.1/com.google.api.gax.paging.PagedListResponse)\n- [2.58.0](/java/docs/reference/gax/2.58.0/com.google.api.gax.paging.PagedListResponse)\n- [2.57.0](/java/docs/reference/gax/2.57.0/com.google.api.gax.paging.PagedListResponse)\n- [2.55.0](/java/docs/reference/gax/2.55.0/com.google.api.gax.paging.PagedListResponse)\n- [2.54.1](/java/docs/reference/gax/2.54.1/com.google.api.gax.paging.PagedListResponse)\n- [2.53.0](/java/docs/reference/gax/2.53.0/com.google.api.gax.paging.PagedListResponse)\n- [2.52.0](/java/docs/reference/gax/2.52.0/com.google.api.gax.paging.PagedListResponse)\n- [2.51.0](/java/docs/reference/gax/2.51.0/com.google.api.gax.paging.PagedListResponse)\n- [2.50.0](/java/docs/reference/gax/2.50.0/com.google.api.gax.paging.PagedListResponse)\n- [2.49.0](/java/docs/reference/gax/2.49.0/com.google.api.gax.paging.PagedListResponse)\n- [2.48.1](/java/docs/reference/gax/2.48.1/com.google.api.gax.paging.PagedListResponse)\n- [2.47.0](/java/docs/reference/gax/2.47.0/com.google.api.gax.paging.PagedListResponse)\n- [2.46.1](/java/docs/reference/gax/2.46.1/com.google.api.gax.paging.PagedListResponse)\n- [2.45.0](/java/docs/reference/gax/2.45.0/com.google.api.gax.paging.PagedListResponse)\n- [2.43.0](/java/docs/reference/gax/2.43.0/com.google.api.gax.paging.PagedListResponse)\n- [2.42.0](/java/docs/reference/gax/2.42.0/com.google.api.gax.paging.PagedListResponse)\n- [2.41.0](/java/docs/reference/gax/2.41.0/com.google.api.gax.paging.PagedListResponse)\n- [2.39.0](/java/docs/reference/gax/2.39.0/com.google.api.gax.paging.PagedListResponse)\n- [2.38.0](/java/docs/reference/gax/2.38.0/com.google.api.gax.paging.PagedListResponse)\n- [2.37.0](/java/docs/reference/gax/2.37.0/com.google.api.gax.paging.PagedListResponse)\n- [2.36.0](/java/docs/reference/gax/2.36.0/com.google.api.gax.paging.PagedListResponse)\n- [2.35.0](/java/docs/reference/gax/2.35.0/com.google.api.gax.paging.PagedListResponse)\n- [2.34.1](/java/docs/reference/gax/2.34.1/com.google.api.gax.paging.PagedListResponse)\n- [2.33.0](/java/docs/reference/gax/2.33.0/com.google.api.gax.paging.PagedListResponse)\n- [2.32.1](/java/docs/reference/gax/2.32.1/com.google.api.gax.paging.PagedListResponse)\n- [2.31.1](/java/docs/reference/gax/2.31.1/com.google.api.gax.paging.PagedListResponse)\n- [2.30.1](/java/docs/reference/gax/2.30.1/com.google.api.gax.paging.PagedListResponse)\n- [2.24.0](/java/docs/reference/gax/2.24.0/com.google.api.gax.paging.PagedListResponse)\n- [2.23.3](/java/docs/reference/gax/2.23.3/com.google.api.gax.paging.PagedListResponse)\n- [2.22.0](/java/docs/reference/gax/2.22.0/com.google.api.gax.paging.PagedListResponse)\n- [2.21.0](/java/docs/reference/gax/2.21.0/com.google.api.gax.paging.PagedListResponse)\n- [2.20.1](/java/docs/reference/gax/2.20.1/com.google.api.gax.paging.PagedListResponse)\n- [2.19.6](/java/docs/reference/gax/2.19.6/com.google.api.gax.paging.PagedListResponse)\n- [2.18.7](/java/docs/reference/gax/2.18.7/com.google.api.gax.paging.PagedListResponse)\n- [2.17.0](/java/docs/reference/gax/2.17.0/com.google.api.gax.paging.PagedListResponse)\n- [2.16.0](/java/docs/reference/gax/2.16.0/com.google.api.gax.paging.PagedListResponse)\n- [2.15.0](/java/docs/reference/gax/2.15.0/com.google.api.gax.paging.PagedListResponse)\n- [2.14.0](/java/docs/reference/gax/2.14.0/com.google.api.gax.paging.PagedListResponse)\n- [2.13.0](/java/docs/reference/gax/2.13.0/com.google.api.gax.paging.PagedListResponse)\n- [2.12.2](/java/docs/reference/gax/2.12.2/com.google.api.gax.paging.PagedListResponse)\n- [2.11.0](/java/docs/reference/gax/2.11.0/com.google.api.gax.paging.PagedListResponse)\n- [2.10.0](/java/docs/reference/gax/2.10.0/com.google.api.gax.paging.PagedListResponse)\n- [2.9.0](/java/docs/reference/gax/2.9.0/com.google.api.gax.paging.PagedListResponse)\n- [2.8.1](/java/docs/reference/gax/2.8.1/com.google.api.gax.paging.PagedListResponse)\n- [2.7.1](/java/docs/reference/gax/2.7.1/com.google.api.gax.paging.PagedListResponse) \n\n public interface PagedListResponse\u003cResourceT\u003e\n\nResponse for paged results from a list API method\n\nThis class is used to access the results of a paged list API method. The management of page\ntokens can be handled automatically, or by the caller. Results can be accessed on a per-element\nor per-page basis.\n\nMethods\n-------\n\n### expandToFixedSizeCollection(int collectionSize)\n\n public abstract FixedSizeCollection\u003cResourceT\u003e expandToFixedSizeCollection(int collectionSize)\n\nReturns a collection of elements with a fixed size set by the collectionSize parameter. The\ncollection will only contain fewer than collectionSize elements if there are no more pages to\nbe retrieved from the server.\n\nNOTE: it is an error to call this method if the optional parameter 'page_size' has not been\nset in the original API call. It is also an error if the collectionSize parameter is less than\nthe page_size.\n\n### getNextPageToken()\n\n public abstract String getNextPageToken()\n\nReturns the token for the next page or an empty string if no more results. Note: This method is\nnot thread-safe.\n\n### getPage()\n\n public abstract Page\u003cResourceT\u003e getPage()\n\nReturns the current page of results. Note: This method is not thread-safe.\n\n### iterateAll()\n\n public abstract Iterable\u003cResourceT\u003e iterateAll()\n\nReturns an iterable that traverses all of the elements of the underlying data source. The data\nis fetched lazily page by page, where each page may contain multiple elements. A new page is\nfetched whenever the elements of any particular page are exhausted. This method is not\nthread-safe.\n\n### iterateFixedSizeCollections(int collectionSize)\n\n public abstract Iterable\u003c? extends FixedSizeCollection\u003cResourceT\u003e\u003e iterateFixedSizeCollections(int collectionSize)\n\nReturns an iterable over fixed size collections of results. The collections are retrieved\nlazily from the underlying API.\n\nEach collection will have collectionSize elements, with the exception of the final\ncollection which may contain fewer elements.\n\nNOTE: it is an error to call this method if the optional parameter 'page_size' has not been\nset in the original API call. It is also an error if the collectionSize parameter is less than\nthe page_size.\n\n### iteratePages()\n\n public abstract Iterable\u003c? extends Page\u003cResourceT\u003e\u003e iteratePages()\n\nReturn an iterable over all Page objects. Page objects are retrieved lazily via API calls until\nall elements have been retrieved."]]
