AsyncConfigurationSettingPaged Class

An async iterable of ConfigurationSettings that supports etag-based change detection.

This class provides asynchronous iteration over configuration settings, with optional support for etag-based change detection. By supplying a list of etags via the match_conditions parameter to the by_page method, you can efficiently detect and retrieve only those pages that have changed since your last retrieval.

Example:


   async for setting in AsyncConfigurationSettingPaged(...):
       # Process each setting asynchronously
       print(setting)

   # To iterate by page and use etag-based change detection:
   etags = ["etag1", "etag2", "etag3"]
   async for page in paged.by_page(match_conditions=etags):
       async for setting in page:
           print(setting)

When match_conditions is provided, each page is checked against the corresponding etag. If the page has not changed (HTTP 304), it is skipped. If the page has changed (HTTP 200), the new page is returned. This allows efficient polling for changes without retrieving unchanged data.

Return an async iterator of items.

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

Constructor

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

Methods

by_page

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

by_page

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

by_page(continuation_token: str | None = None, *, match_conditions: List[str] | None = None) -> Any

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

Keyword-Only Parameters

Name Description
match_conditions
list[str] or None

A list of etags to check for changes. If provided, the iterator will check each page against the corresponding etag and only return pages that have changed.

Default value: None

Returns

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

An async iterator of pages (themselves iterator of objects)