PaginationIterable
Stay organized with collections
Save and categorize content based on your preferences.
Iterable which handles pagination for iterating over set of objects.
Nested Class Summary
|
class |
PaginationIterable.Page<T, Q> |
Represents set of items and optional continuation token to fetch additional items. |
Public Constructor Summary
Public Method Summary
|
abstract
Page<T, Q>
|
getPage(Optional<Q> nextPage)
Return next set of objects based on optional pagination token.
|
|
Iterator<T>
|
|
Inherited Method Summary
From class
java.lang.Object
|
boolean
|
equals(Object arg0)
|
|
final
Class<?>
|
getClass()
|
|
int
|
hashCode()
|
|
final
void
|
notify()
|
|
final
void
|
notifyAll()
|
|
String
|
toString()
|
|
final
void
|
wait(long arg0, int arg1)
|
|
final
void
|
wait(long arg0)
|
|
final
void
|
wait()
|
From interface
java.lang.Iterable
|
void
|
forEach(Consumer<? super T> arg0)
|
|
abstract
Iterator<T>
|
iterator()
|
|
Spliterator<T>
|
spliterator()
|
Public Methods
public
abstract
Page<T, Q>
getPage
(Optional<Q> nextPage)
Return next set of objects based on optional pagination token.
Parameters
| nextPage |
pagination token |
Throws
| IOException |
if fetching next set of objects fails
|
public
Iterator<T>
iterator
()
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-03-18 UTC.
[null,null,["Last updated 2025-03-18 UTC."],[],[],null,["# PaginationIterable\n\npublic abstract class **PaginationIterable** extends Object \nimplements Iterable\\\u003cT\\\u003e \n[Iterable](/workspace/cloud-search/docs/reference/sdk/java/lang/Iterable) which handles pagination for iterating over set of objects. \n\n### Nested Class Summary\n\n|-------|---|---|------------------------------------------------------------------------------------|\n| class | [PaginationIterable.Page](/workspace/cloud-search/docs/reference/sdk/com/google/enterprise/cloudsearch/sdk/PaginationIterable.Page)\\\u003cT, Q\\\u003e || Represents set of items and optional continuation token to fetch additional items. |\n\n### Public Constructor Summary\n\n|---|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| | [PaginationIterable](/workspace/cloud-search/docs/reference/sdk/com/google/enterprise/cloudsearch/sdk/PaginationIterable#PaginationIterable(java.util.Optional\u003cQ\u003e))(Optional\\\u003cQ\\\u003e startPage) Creates an instance of [PaginationIterable](/workspace/cloud-search/docs/reference/sdk/com/google/enterprise/cloudsearch/sdk/PaginationIterable) |\n\n### Public Method Summary\n\n|-----------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| abstract [Page](/workspace/cloud-search/docs/reference/sdk/com/google/enterprise/cloudsearch/sdk/PaginationIterable.Page)\\\u003cT, Q\\\u003e | [getPage](/workspace/cloud-search/docs/reference/sdk/com/google/enterprise/cloudsearch/sdk/PaginationIterable#getPage(java.util.Optional\u003cQ\u003e))(Optional\\\u003cQ\\\u003e nextPage) Return next set of objects based on optional pagination token. |\n| Iterator\\\u003cT\\\u003e | [iterator](/workspace/cloud-search/docs/reference/sdk/com/google/enterprise/cloudsearch/sdk/PaginationIterable#iterator())() |\n\n### Inherited Method Summary\n\nFrom class java.lang.Object \n\n|------------------|---------------------------|\n| boolean | equals(Object arg0) |\n| final Class\\\u003c?\\\u003e | getClass() |\n| int | hashCode() |\n| final void | notify() |\n| final void | notifyAll() |\n| String | toString() |\n| final void | wait(long arg0, int arg1) |\n| final void | wait(long arg0) |\n| final void | wait() |\n\nFrom interface java.lang.Iterable \n\n|------------------------|-------------------------------------|\n| void | forEach(Consumer\\\u003c? super T\\\u003e arg0) |\n| abstract Iterator\\\u003cT\\\u003e | iterator() |\n| Spliterator\\\u003cT\\\u003e | spliterator() |\n\nPublic Constructors\n-------------------\n\n#### public\n**PaginationIterable**\n(Optional\\\u003cQ\\\u003e startPage)\n\nCreates an instance of [PaginationIterable](/workspace/cloud-search/docs/reference/sdk/com/google/enterprise/cloudsearch/sdk/PaginationIterable) \n\n##### Parameters\n\n| startPage | |\n|-----------|---|\n\nPublic Methods\n--------------\n\n#### public abstract [Page](/workspace/cloud-search/docs/reference/sdk/com/google/enterprise/cloudsearch/sdk/PaginationIterable.Page)\\\u003cT, Q\\\u003e\n**getPage**\n(Optional\\\u003cQ\\\u003e nextPage)\n\nReturn next set of objects based on optional pagination token. \n\n##### Parameters\n\n| nextPage | pagination token |\n|----------|------------------|\n\n##### Returns\n\n- [PaginationIterable.Page](/workspace/cloud-search/docs/reference/sdk/com/google/enterprise/cloudsearch/sdk/PaginationIterable.Page) containing next set of objects and optional continuation token. \n\n##### Throws\n\n| IOException | if fetching next set of objects fails |\n|-------------|---------------------------------------|\n\n#### public Iterator\\\u003cT\\\u003e\n**iterator**\n()\n\n\u003cbr /\u003e"]]
