dropbox.files.DeleteBatchJobStatus

class documentation

class DeleteBatchJobStatus(async_.PollResultBase): (source)

View In Hierarchy

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 DeleteBatchResult DeleteBatchJobStatus.complete: The batch delete has finished. :ivar DeleteBatchError DeleteBatchJobStatus.failed: The batch delete has failed.

Class Method complete Create an instance of this class set to the ``complete`` tag with value ``val``.
Class Method failed Create an instance of this class set to the ``failed`` tag with value ``val``.
Method get_complete The batch delete has finished.
Method get_failed The batch delete has failed.
Method is_complete Check if the union tag is ``complete``.
Method is_failed Check if the union tag is ``failed``.
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 PollResultBase:

Method is_in_progress Check if the union tag is ``in_progress``.
Class Variable in_progress Undocumented
@classmethod
def complete(cls, val): (source)

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

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

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

def get_complete(self): (source)

The batch delete has finished. Only call this if :meth:`is_complete` is true. :rtype: DeleteBatchResult

def get_failed(self): (source)

The batch delete has failed. Only call this if :meth:`is_failed` is true. :rtype: DeleteBatchError

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

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

Undocumented

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

Undocumented