dropbox.files.RelocationBatchV2JobStatus

class documentation

class RelocationBatchV2JobStatus(async_.PollResultBase): (source)

Result returned by :meth:`dropbox.dropbox_client.Dropbox.files_copy_batch_check` or :meth:`dropbox.dropbox_client.Dropbox.files_move_batch_check` that may either be in progress or completed with result for each entry. 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 RelocationBatchV2Result RelocationBatchV2JobStatus.complete: The copy or move batch job has finished.

Class Method	`complete`	Create an instance of this class set to the ``complete`` tag with value ``val``.
Method	`get_complete`	The copy or move batch job has finished.
Method	`is_complete`	Check if the union tag is ``complete``.
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 complete(cls, val): (source) ¶

Create an instance of this class set to the ``complete`` tag with value ``val``. :param RelocationBatchV2Result val: :rtype: RelocationBatchV2JobStatus

def get_complete(self): (source) ¶

The copy or move batch job has finished. Only call this if :meth:`is_complete` is true. :rtype: RelocationBatchV2Result

def is_complete(self): (source) ¶

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

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

overrides dropbox.async_.PollResultBase._process_custom_annotations

Undocumented