dropbox.files.RelocationBatchV2Launch

class documentation

class RelocationBatchV2Launch(async_.LaunchResultBase): (source)

Result returned by :meth:`dropbox.dropbox_client.Dropbox.files_copy_batch` or :meth:`dropbox.dropbox_client.Dropbox.files_move_batch` that may either launch an asynchronous job or complete synchronously. 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	`complete`	Create an instance of this class set to the ``complete`` tag with value ``val``.
Method	`get_complete`	Only call this if :meth:`is_complete` is true.
Method	`is_complete`	Check if the union tag is ``complete``.
Method	`_process_custom_annotations`	Undocumented

Inherited from LaunchResultBase:

Class Method	`async_job_id`	Create an instance of this class set to the ``async_job_id`` tag with value ``val``.
Method	`get_async_job_id`	This response indicates that the processing is asynchronous. The string is an id that can be used to obtain the status of the asynchronous job.
Method	`is_async_job_id`	Check if the union tag is ``async_job_id``.
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: RelocationBatchV2Launch

def get_complete(self): (source) ¶

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_.LaunchResultBase._process_custom_annotations

Undocumented