class documentation

class Cursor(bb.Struct): (source)

View In Hierarchy

:ivar paper.Cursor.value: The actual cursor value. :ivar paper.Cursor.expiration: Expiration time of ``value``. Some cursors might have expiration time assigned. This is a UTC value after which the cursor is no longer valid and the API starts returning an error. If cursor expires a new one needs to be obtained and pagination needs to be restarted. Some cursors might be short-lived some cursors might be long-lived. This really depends on the sorting type and order, e.g.: 1. on one hand, listing docs created by the user, sorted by the created time ascending will have undefinite expiration because the results cannot change while the iteration is happening. This cursor would be suitable for long term polling. 2. on the other hand, listing docs sorted by the last modified time will have a very short expiration as docs do get modified very often and the modified time can be changed while the iteration is happening thus altering the results.

Method __init__ Undocumented
Class Variable __slots__ Undocumented
Instance Variable expiration Undocumented
Instance Variable value Undocumented
Method _process_custom_annotations Undocumented
Class Variable _has_required_fields Undocumented
Instance Variable _expiration_value Undocumented
Instance Variable _value_value Undocumented
def __init__(self, value=None, expiration=None): (source)

Undocumented

__slots__: list[str] = (source)

Undocumented

expiration = (source)

Undocumented

Undocumented

def _process_custom_annotations(self, annotation_type, field_path, processor): (source)

Undocumented

_has_required_fields: bool = (source)

Undocumented

_expiration_value = (source)

Undocumented

_value_value = (source)

Undocumented