Skip to content

IteratorDescription

Source code in docs_src/capo_keyspacesstreams/types/iterator_description.py 
11
12
13
14
15
class IteratorDescription(TypedDict, closed=True):
    iterator_position: NotRequired[
        "capo_keyspacesstreams.types.iterator_position.IteratorPosition"
    ]
    """<p> Indicates the current iterator's position within the shard. The possible values are: </p> <ul> <li> <p> <code>AT_TIP</code> - No more records are currently available.</p> </li> <li> <p> <code>BEHIND_TIP</code> - Additional records may be available.</p> </li> </ul> <p>Stream progresses in absence of customer records. <code>BEHIND_TIP</code> with an empty <code>changeRecords</code> list indicates the stream is progressing but no customer records are available at this position. Continue polling normally.</p>"""

iterator_position instance-attribute 

iterator_position: NotRequired[IteratorPosition]

Indicates the current iterator's position within the shard. The possible values are:

  • AT_TIP - No more records are currently available.

  • BEHIND_TIP - Additional records may be available.

Stream progresses in absence of customer records. BEHIND_TIP with an empty changeRecords list indicates the stream is progressing but no customer records are available at this position. Continue polling normally.