AsyncItemPaged Class

  • Reference

Return an async iterator of items.

args and kwargs will be passed to the AsyncPageIterator constructor directly, except page_iterator_class

Inheritance
AsyncIterator
AsyncItemPaged
Generic
AsyncItemPaged

Constructor

AsyncItemPaged(*args: Any, **kwargs: Any)

Methods

by_page

Get an async iterator of pages of objects, instead of an async iterator of objects.

by_page

Get an async iterator of pages of objects, instead of an async iterator of objects.

by_page(continuation_token: str | None = None) -> AsyncIterator[AsyncIterator[ReturnType]]

Parameters

Name Description
continuation_token
str

An opaque continuation token. This value can be retrieved from the continuation_token field of a previous generator object. If specified, this generator will begin returning results from this point.

default value: None

Returns

Type Description
AsyncIterator[AsyncIterator[<xref:ReturnType>]]

An async iterator of pages (themselves async iterator of objects)