dropbox.sharing.JobStatus

class documentation

class JobStatus(async_.PollResultBase): (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. :ivar sharing.JobStatus.complete: The asynchronous job has finished. :ivar JobError JobStatus.failed: The asynchronous job returned an error.

Class Method	`failed`	Create an instance of this class set to the ``failed`` tag with value ``val``.
Method	`get_failed`	The asynchronous job returned an error.
Method	`is_complete`	Check if the union tag is ``complete``.
Method	`is_failed`	Check if the union tag is ``failed``.
Class Variable	`complete`	Undocumented
Method	`_process_custom_annotations`	Undocumented

Inherited from PollResultBase:

Method	`is_in_progress`	Check if the union tag is ``in_progress``.
Class Variable	`in_progress`	Undocumented
Class Variable	`_catch_all`	Undocumented

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

Create an instance of this class set to the ``failed`` tag with value ``val``. :param JobError val: :rtype: JobStatus

def get_failed(self): (source) ¶

The asynchronous job returned an error. Only call this if :meth:`is_failed` is true. :rtype: JobError

def is_complete(self): (source) ¶

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

def is_failed(self): (source) ¶

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

complete = (source) ¶

Undocumented

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

overrides dropbox.async_.PollResultBase._process_custom_annotations

Undocumented