class documentation

class PaperApiCursorError(bb.Union): (source)

View In Hierarchy

This class acts as a tagged union. Only one of the ``is_*`` methods will return true. To get the associated value of a tag (if one exists), use the corresponding ``get_*`` method. :ivar paper.PaperApiCursorError.expired_cursor: The provided cursor is expired. :ivar paper.PaperApiCursorError.invalid_cursor: The provided cursor is invalid. :ivar paper.PaperApiCursorError.wrong_user_in_cursor: The provided cursor contains invalid user. :ivar paper.PaperApiCursorError.reset: Indicates that the cursor has been invalidated. Call the corresponding non-continue endpoint to obtain a new cursor.

Method is_expired_cursor Check if the union tag is ``expired_cursor``.
Method is_invalid_cursor Check if the union tag is ``invalid_cursor``.
Method is_other Check if the union tag is ``other``.
Method is_reset Check if the union tag is ``reset``.
Method is_wrong_user_in_cursor Check if the union tag is ``wrong_user_in_cursor``.
Class Variable expired_cursor Undocumented
Class Variable invalid_cursor Undocumented
Class Variable other Undocumented
Class Variable reset Undocumented
Class Variable wrong_user_in_cursor Undocumented
Method _process_custom_annotations Undocumented
Class Variable _catch_all Undocumented
def is_expired_cursor(self): (source)

Check if the union tag is ``expired_cursor``. :rtype: bool

def is_invalid_cursor(self): (source)

Check if the union tag is ``invalid_cursor``. :rtype: bool

def is_other(self): (source)

Check if the union tag is ``other``. :rtype: bool

def is_reset(self): (source)

Check if the union tag is ``reset``. :rtype: bool

def is_wrong_user_in_cursor(self): (source)

Check if the union tag is ``wrong_user_in_cursor``. :rtype: bool

expired_cursor = (source)

Undocumented

invalid_cursor = (source)

Undocumented

Undocumented

Undocumented

wrong_user_in_cursor = (source)

Undocumented

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

Undocumented

_catch_all: str = (source)

Undocumented