A FixedSizeCollection object wraps multiple API list method responses into a single collection
with a fixed number of elements.
Callers can iterate over the FixedSizeCollection object to get all elements in the collection.
The number of elements is guaranteed to be equal to the value of the collectionSize parameter
passed to expandPage(), unless the API has no more elements to return. The FixedSizeCollection
object also provides methods to retrieve additional FixedSizeCollections using the page token.
Type Parameter
Name
Description
ResourceT
Methods
getCollectionSize()
publicabstractintgetCollectionSize()
Returns the number of elements in the collection. This will be equal to the collectionSize
parameter used at construction unless there are no elements remaining to be retrieved.
[[["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-08-15 UTC."],[[["\u003cp\u003eThis webpage provides documentation for the \u003ccode\u003eFixedSizeCollection\u003c/code\u003e interface in the Google API Client Library for Java (gax), with the latest version being 2.63.1.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eFixedSizeCollection\u003c/code\u003e allows you to wrap multiple API list method responses into a single collection with a defined number of elements, ensuring a specific collection size unless no further elements are available.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eFixedSizeCollection\u003c/code\u003e interface provides methods to retrieve the collection size, fetch the next collection, obtain the next page token, iterate over the elements, and check for the presence of additional elements.\u003c/p\u003e\n"],["\u003cp\u003eThe provided list also contains all previous versions, from 2.62.0 down to 2.7.1.\u003c/p\u003e\n"]]],[],null,["# Interface FixedSizeCollection<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.FixedSizeCollection)\n- [2.68.2](/java/docs/reference/gax/2.68.2/com.google.api.gax.paging.FixedSizeCollection)\n- [2.67.0](/java/docs/reference/gax/2.67.0/com.google.api.gax.paging.FixedSizeCollection)\n- [2.66.0](/java/docs/reference/gax/2.66.0/com.google.api.gax.paging.FixedSizeCollection)\n- [2.65.0](/java/docs/reference/gax/2.65.0/com.google.api.gax.paging.FixedSizeCollection)\n- [2.63.1](/java/docs/reference/gax/2.63.1/com.google.api.gax.paging.FixedSizeCollection)\n- [2.62.0](/java/docs/reference/gax/2.62.0/com.google.api.gax.paging.FixedSizeCollection)\n- [2.61.0](/java/docs/reference/gax/2.61.0/com.google.api.gax.paging.FixedSizeCollection)\n- [2.60.0](/java/docs/reference/gax/2.60.0/com.google.api.gax.paging.FixedSizeCollection)\n- [2.59.1](/java/docs/reference/gax/2.59.1/com.google.api.gax.paging.FixedSizeCollection)\n- [2.58.0](/java/docs/reference/gax/2.58.0/com.google.api.gax.paging.FixedSizeCollection)\n- [2.57.0](/java/docs/reference/gax/2.57.0/com.google.api.gax.paging.FixedSizeCollection)\n- [2.55.0](/java/docs/reference/gax/2.55.0/com.google.api.gax.paging.FixedSizeCollection)\n- [2.54.1](/java/docs/reference/gax/2.54.1/com.google.api.gax.paging.FixedSizeCollection)\n- [2.53.0](/java/docs/reference/gax/2.53.0/com.google.api.gax.paging.FixedSizeCollection)\n- [2.52.0](/java/docs/reference/gax/2.52.0/com.google.api.gax.paging.FixedSizeCollection)\n- [2.51.0](/java/docs/reference/gax/2.51.0/com.google.api.gax.paging.FixedSizeCollection)\n- [2.50.0](/java/docs/reference/gax/2.50.0/com.google.api.gax.paging.FixedSizeCollection)\n- [2.49.0](/java/docs/reference/gax/2.49.0/com.google.api.gax.paging.FixedSizeCollection)\n- [2.48.1](/java/docs/reference/gax/2.48.1/com.google.api.gax.paging.FixedSizeCollection)\n- [2.47.0](/java/docs/reference/gax/2.47.0/com.google.api.gax.paging.FixedSizeCollection)\n- [2.46.1](/java/docs/reference/gax/2.46.1/com.google.api.gax.paging.FixedSizeCollection)\n- [2.45.0](/java/docs/reference/gax/2.45.0/com.google.api.gax.paging.FixedSizeCollection)\n- [2.43.0](/java/docs/reference/gax/2.43.0/com.google.api.gax.paging.FixedSizeCollection)\n- [2.42.0](/java/docs/reference/gax/2.42.0/com.google.api.gax.paging.FixedSizeCollection)\n- [2.41.0](/java/docs/reference/gax/2.41.0/com.google.api.gax.paging.FixedSizeCollection)\n- [2.39.0](/java/docs/reference/gax/2.39.0/com.google.api.gax.paging.FixedSizeCollection)\n- [2.38.0](/java/docs/reference/gax/2.38.0/com.google.api.gax.paging.FixedSizeCollection)\n- [2.37.0](/java/docs/reference/gax/2.37.0/com.google.api.gax.paging.FixedSizeCollection)\n- [2.36.0](/java/docs/reference/gax/2.36.0/com.google.api.gax.paging.FixedSizeCollection)\n- [2.35.0](/java/docs/reference/gax/2.35.0/com.google.api.gax.paging.FixedSizeCollection)\n- [2.34.1](/java/docs/reference/gax/2.34.1/com.google.api.gax.paging.FixedSizeCollection)\n- [2.33.0](/java/docs/reference/gax/2.33.0/com.google.api.gax.paging.FixedSizeCollection)\n- [2.32.1](/java/docs/reference/gax/2.32.1/com.google.api.gax.paging.FixedSizeCollection)\n- [2.31.1](/java/docs/reference/gax/2.31.1/com.google.api.gax.paging.FixedSizeCollection)\n- [2.30.1](/java/docs/reference/gax/2.30.1/com.google.api.gax.paging.FixedSizeCollection)\n- [2.24.0](/java/docs/reference/gax/2.24.0/com.google.api.gax.paging.FixedSizeCollection)\n- [2.23.3](/java/docs/reference/gax/2.23.3/com.google.api.gax.paging.FixedSizeCollection)\n- [2.22.0](/java/docs/reference/gax/2.22.0/com.google.api.gax.paging.FixedSizeCollection)\n- [2.21.0](/java/docs/reference/gax/2.21.0/com.google.api.gax.paging.FixedSizeCollection)\n- [2.20.1](/java/docs/reference/gax/2.20.1/com.google.api.gax.paging.FixedSizeCollection)\n- [2.19.6](/java/docs/reference/gax/2.19.6/com.google.api.gax.paging.FixedSizeCollection)\n- [2.18.7](/java/docs/reference/gax/2.18.7/com.google.api.gax.paging.FixedSizeCollection)\n- [2.17.0](/java/docs/reference/gax/2.17.0/com.google.api.gax.paging.FixedSizeCollection)\n- [2.16.0](/java/docs/reference/gax/2.16.0/com.google.api.gax.paging.FixedSizeCollection)\n- [2.15.0](/java/docs/reference/gax/2.15.0/com.google.api.gax.paging.FixedSizeCollection)\n- [2.14.0](/java/docs/reference/gax/2.14.0/com.google.api.gax.paging.FixedSizeCollection)\n- [2.13.0](/java/docs/reference/gax/2.13.0/com.google.api.gax.paging.FixedSizeCollection)\n- [2.12.2](/java/docs/reference/gax/2.12.2/com.google.api.gax.paging.FixedSizeCollection)\n- [2.11.0](/java/docs/reference/gax/2.11.0/com.google.api.gax.paging.FixedSizeCollection)\n- [2.10.0](/java/docs/reference/gax/2.10.0/com.google.api.gax.paging.FixedSizeCollection)\n- [2.9.0](/java/docs/reference/gax/2.9.0/com.google.api.gax.paging.FixedSizeCollection)\n- [2.8.1](/java/docs/reference/gax/2.8.1/com.google.api.gax.paging.FixedSizeCollection)\n- [2.7.1](/java/docs/reference/gax/2.7.1/com.google.api.gax.paging.FixedSizeCollection) \n\n public interface FixedSizeCollection\u003cResourceT\u003e\n\nA FixedSizeCollection object wraps multiple API list method responses into a single collection\nwith a fixed number of elements.\n\nCallers can iterate over the FixedSizeCollection object to get all elements in the collection.\nThe number of elements is guaranteed to be equal to the value of the collectionSize parameter\npassed to expandPage(), unless the API has no more elements to return. The FixedSizeCollection\nobject also provides methods to retrieve additional FixedSizeCollections using the page token.\n\nMethods\n-------\n\n### getCollectionSize()\n\n public abstract int getCollectionSize()\n\nReturns the number of elements in the collection. This will be equal to the collectionSize\nparameter used at construction unless there are no elements remaining to be retrieved.\n\n### getNextCollection()\n\n public abstract FixedSizeCollection\u003cResourceT\u003e getNextCollection()\n\nRetrieves the next FixedSizeCollection using one or more API calls.\n\n### getNextPageToken()\n\n public abstract String getNextPageToken()\n\nReturns a page token that can be passed into the API list method to retrieve additional\nelements.\n\n### getValues()\n\n public abstract Iterable\u003cResourceT\u003e getValues()\n\nReturns an iterable over the elements in this FixedSizeCollection.\n\n### hasNextCollection()\n\n public abstract boolean hasNextCollection()\n\nReturns true if there are more elements that can be retrieved from the API."]]
