class documentation

class UploadError(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 UploadWriteFailed UploadError.path: Unable to save the uploaded contents to a file. :ivar InvalidPropertyGroupError UploadError.properties_error: The supplied property group is invalid. The file has uploaded without property groups. :ivar files.UploadError.payload_too_large: The request payload must be at most 150 MB. :ivar files.UploadError.content_hash_mismatch: The content received by the Dropbox server in this call does not match the provided content hash.

Class Method path Create an instance of this class set to the ``path`` tag with value ``val``.
Class Method properties_error Create an instance of this class set to the ``properties_error`` tag with value ``val``.
Method get_path Unable to save the uploaded contents to a file.
Method get_properties_error The supplied property group is invalid. The file has uploaded without property groups.
Method is_content_hash_mismatch Check if the union tag is ``content_hash_mismatch``.
Method is_other Check if the union tag is ``other``.
Method is_path Check if the union tag is ``path``.
Method is_payload_too_large Check if the union tag is ``payload_too_large``.
Method is_properties_error Check if the union tag is ``properties_error``.
Class Variable content_hash_mismatch Undocumented
Class Variable other Undocumented
Class Variable payload_too_large Undocumented
Method _process_custom_annotations Undocumented
Class Variable _catch_all Undocumented
@classmethod
def path(cls, val): (source)

Create an instance of this class set to the ``path`` tag with value ``val``. :param UploadWriteFailed val: :rtype: UploadError

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

Create an instance of this class set to the ``properties_error`` tag with value ``val``. :param file_properties.InvalidPropertyGroupError val: :rtype: UploadError

def get_path(self): (source)

Unable to save the uploaded contents to a file. Only call this if :meth:`is_path` is true. :rtype: UploadWriteFailed

def get_properties_error(self): (source)

The supplied property group is invalid. The file has uploaded without property groups. Only call this if :meth:`is_properties_error` is true. :rtype: file_properties.InvalidPropertyGroupError

def is_content_hash_mismatch(self): (source)

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

def is_other(self): (source)

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

def is_path(self): (source)

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

def is_payload_too_large(self): (source)

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

def is_properties_error(self): (source)

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

content_hash_mismatch = (source)

Undocumented

Undocumented

payload_too_large = (source)

Undocumented

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

Undocumented

_catch_all: str = (source)

Undocumented