dropbox.files.UploadSessionFinishBatchResultEntry

class documentation

class UploadSessionFinishBatchResultEntry(bb.Union): (source)

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.

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`	Only call this if :meth:`is_failure` is true.
Method	`get_success`	Only call this if :meth:`is_success` is true.
Method	`is_failure`	Check if the union tag is ``failure``.
Method	`is_success`	Check if the union tag is ``success``.
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 UploadSessionFinishError val: :rtype: UploadSessionFinishBatchResultEntry

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

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

def get_failure(self): (source) ¶

Only call this if :meth:`is_failure` is true. :rtype: UploadSessionFinishError

def get_success(self): (source) ¶

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

def is_failure(self): (source) ¶

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

def is_success(self): (source) ¶

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

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

Undocumented

_catch_all = (source) ¶

Undocumented