class documentation

class GetThumbnailBatchResultEntry(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 ThumbnailError GetThumbnailBatchResultEntry.failure: The result for this file if it was an error.

Class Method failure Create an instance of this class set to the ``failure`` tag with value ``val``.
Class Method success Create an instance of this class set to the ``success`` tag with value ``val``.
Method get_failure The result for this file if it was an error.
Method get_success Only call this if :meth:`is_success` is true.
Method is_failure Check if the union tag is ``failure``.
Method is_other Check if the union tag is ``other``.
Method is_success Check if the union tag is ``success``.
Class Variable other Undocumented
Method _process_custom_annotations Undocumented
Class Variable _catch_all Undocumented
@classmethod
def failure(cls, val): (source)

Create an instance of this class set to the ``failure`` tag with value ``val``. :param ThumbnailError val: :rtype: GetThumbnailBatchResultEntry

@classmethod
def success(cls, val): (source)

Create an instance of this class set to the ``success`` tag with value ``val``. :param GetThumbnailBatchResultData val: :rtype: GetThumbnailBatchResultEntry

def get_failure(self): (source)

The result for this file if it was an error. Only call this if :meth:`is_failure` is true. :rtype: ThumbnailError

def get_success(self): (source)

Only call this if :meth:`is_success` is true. :rtype: GetThumbnailBatchResultData

def is_failure(self): (source)

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

def is_other(self): (source)

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

def is_success(self): (source)

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

Undocumented

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

Undocumented

_catch_all: str = (source)

Undocumented