ConfigurationSettingPaged Class

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

This class extends ItemPaged to provide efficient monitoring of configuration changes by using ETags. When used with the match_conditions parameter in by_page(), it only returns pages that have changed since the provided ETags were collected.

Example:

   # Get initial page ETags
   items = client.list_configuration_settings(key_filter="sample_*")
   match_conditions = [page.etag for page in items.by_page()]

   # Later, check for changes - only changed pages are returned
   items = client.list_configuration_settings(key_filter="sample_*")
   for page in items.by_page(match_conditions=match_conditions):
       # Process only changed pages
       pass

Return an iterator of items.

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

Constructor

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

Methods

by_page	Get an iterator of pages of objects, instead of an iterator of objects.
next	Get the next item in the iterator.

by_page

Get an 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
<xref:iterator>[<xref:iterator>[<xref:ReturnType>]]	An iterator of pages (themselves iterator of objects)

next

Get the next item in the iterator.

next() -> ReturnType

Returns

Type	Description
<xref:ReturnType>	The next item in the iterator.

Exceptions

Type	Description
StopIteration	If there are no more items to return.