dropbox.files.RelocationBatchLaunch

class documentation

class RelocationBatchLaunch(async_.LaunchResultBase): (source)

View In Hierarchy

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 is_other Check if the union tag is ``other``.
Class Variable other Undocumented
Method _process_custom_annotations Undocumented
Class Variable _catch_all 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``.
@classmethod
def complete(cls, val): (source)

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

def get_complete(self): (source)

Only call this if :meth:`is_complete` is true. :rtype: RelocationBatchResult

def is_complete(self): (source)

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

def is_other(self): (source)

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

other = (source)

Undocumented

def _process_custom_annotations(self, annotation_type, field_path, processor): (source)
overrides dropbox.async_.LaunchResultBase._process_custom_annotations

Undocumented

_catch_all: str = (source)
overrides dropbox.async_.LaunchResultBase._catch_all

Undocumented