class documentation

class WriteError(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 Optional[str] files.WriteError.malformed_path: The given path does not satisfy the required path format. Please refer to the :link:`Path formats documentation https://www.dropbox.com/developers/documentation/http/documentation#path-formats` for more information. :ivar WriteConflictError WriteError.conflict: Couldn't write to the target path because there was something in the way. :ivar files.WriteError.no_write_permission: The user doesn't have permissions to write to the target location. :ivar files.WriteError.insufficient_space: The user doesn't have enough available space (bytes) to write more data. :ivar files.WriteError.disallowed_name: Dropbox will not save the file or folder because of its name. :ivar files.WriteError.team_folder: This endpoint cannot move or delete team folders. :ivar files.WriteError.operation_suppressed: This file operation is not allowed at this path. :ivar files.WriteError.too_many_write_operations: There are too many write operations in user's Dropbox. Please retry this request.

Class Method conflict Create an instance of this class set to the ``conflict`` tag with value ``val``.
Class Method malformed_path Create an instance of this class set to the ``malformed_path`` tag with value ``val``.
Method get_conflict Couldn't write to the target path because there was something in the way.
Method get_malformed_path The given path does not satisfy the required path format. Please refer to the `Path formats documentation <https://www.dropbox.com/developers/documentation/http/documentation#path-formats>`_ for more information.
Method is_conflict Check if the union tag is ``conflict``.
Method is_disallowed_name Check if the union tag is ``disallowed_name``.
Method is_insufficient_space Check if the union tag is ``insufficient_space``.
Method is_malformed_path Check if the union tag is ``malformed_path``.
Method is_no_write_permission Check if the union tag is ``no_write_permission``.
Method is_operation_suppressed Check if the union tag is ``operation_suppressed``.
Method is_other Check if the union tag is ``other``.
Method is_team_folder Check if the union tag is ``team_folder``.
Method is_too_many_write_operations Check if the union tag is ``too_many_write_operations``.
Class Variable disallowed_name Undocumented
Class Variable insufficient_space Undocumented
Class Variable no_write_permission Undocumented
Class Variable operation_suppressed Undocumented
Class Variable other Undocumented
Class Variable team_folder Undocumented
Class Variable too_many_write_operations Undocumented
Method _process_custom_annotations Undocumented
Class Variable _catch_all Undocumented
@classmethod
def conflict(cls, val): (source)

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

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

Create an instance of this class set to the ``malformed_path`` tag with value ``val``. :param Optional[str] val: :rtype: WriteError

def get_conflict(self): (source)

Couldn't write to the target path because there was something in the way. Only call this if :meth:`is_conflict` is true. :rtype: WriteConflictError

def get_malformed_path(self): (source)

The given path does not satisfy the required path format. Please refer to the `Path formats documentation <https://www.dropbox.com/developers/documentation/http/documentation#path-formats>`_ for more information. Only call this if :meth:`is_malformed_path` is true. :rtype: Optional[str]

def is_conflict(self): (source)

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

def is_disallowed_name(self): (source)

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

def is_insufficient_space(self): (source)

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

def is_malformed_path(self): (source)

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

def is_no_write_permission(self): (source)

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

def is_operation_suppressed(self): (source)

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

def is_other(self): (source)

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

def is_team_folder(self): (source)

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

def is_too_many_write_operations(self): (source)

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

disallowed_name = (source)

Undocumented

insufficient_space = (source)

Undocumented

no_write_permission = (source)

Undocumented

operation_suppressed = (source)

Undocumented

Undocumented

team_folder = (source)

Undocumented

too_many_write_operations = (source)

Undocumented

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

Undocumented

_catch_all: str = (source)

Undocumented