dropbox.files.RestoreError

class documentation

class RestoreError(bb.Union): (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 LookupError RestoreError.path_lookup: An error occurs when downloading metadata for the file. :ivar WriteError RestoreError.path_write: An error occurs when trying to restore the file to that path. :ivar files.RestoreError.invalid_revision: The revision is invalid. It may not exist or may point to a deleted file. :ivar files.RestoreError.in_progress: The restore is currently executing, but has not yet completed.

Class Method path_lookup Create an instance of this class set to the ``path_lookup`` tag with value ``val``.
Class Method path_write Create an instance of this class set to the ``path_write`` tag with value ``val``.
Method get_path_lookup An error occurs when downloading metadata for the file.
Method get_path_write An error occurs when trying to restore the file to that path.
Method is_in_progress Check if the union tag is ``in_progress``.
Method is_invalid_revision Check if the union tag is ``invalid_revision``.
Method is_other Check if the union tag is ``other``.
Method is_path_lookup Check if the union tag is ``path_lookup``.
Method is_path_write Check if the union tag is ``path_write``.
Class Variable in_progress Undocumented
Class Variable invalid_revision Undocumented
Class Variable other Undocumented
Method _process_custom_annotations Undocumented
Class Variable _catch_all Undocumented
@classmethod
def path_lookup(cls, val): (source)

Create an instance of this class set to the ``path_lookup`` tag with value ``val``. :param LookupError val: :rtype: RestoreError

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

Create an instance of this class set to the ``path_write`` tag with value ``val``. :param WriteError val: :rtype: RestoreError

def get_path_lookup(self): (source)

An error occurs when downloading metadata for the file. Only call this if :meth:`is_path_lookup` is true. :rtype: LookupError

def get_path_write(self): (source)

An error occurs when trying to restore the file to that path. Only call this if :meth:`is_path_write` is true. :rtype: WriteError

def is_in_progress(self): (source)

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

def is_invalid_revision(self): (source)

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

def is_other(self): (source)

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

def is_path_lookup(self): (source)

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

def is_path_write(self): (source)

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

in_progress = (source)

Undocumented

invalid_revision = (source)

Undocumented

other = (source)

Undocumented

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

Undocumented

_catch_all: str = (source)

Undocumented