dropbox.files.UploadSessionFinishError

class documentation

class UploadSessionFinishError(bb.Union): (source)

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 UploadSessionLookupError UploadSessionFinishError.lookup_failed: The session arguments are incorrect; the value explains the reason. :ivar WriteError UploadSessionFinishError.path: Unable to save the uploaded contents to a file. Data has already been appended to the upload session. Please retry with empty data body and updated offset. :ivar InvalidPropertyGroupError UploadSessionFinishError.properties_error: The supplied property group is invalid. The file has uploaded without property groups. :ivar files.UploadSessionFinishError.too_many_shared_folder_targets: The batch request commits files into too many different shared folders. Please limit your batch request to files contained in a single shared folder. :ivar files.UploadSessionFinishError.too_many_write_operations: There are too many write operations happening in the user's Dropbox. You should retry uploading this file. :ivar files.UploadSessionFinishError.concurrent_session_data_not_allowed: Uploading data not allowed when finishing concurrent upload session. :ivar files.UploadSessionFinishError.concurrent_session_not_closed: Concurrent upload sessions need to be closed before finishing. :ivar files.UploadSessionFinishError.concurrent_session_missing_data: Not all pieces of data were uploaded before trying to finish the session. :ivar files.UploadSessionFinishError.payload_too_large: The request payload must be at most 150 MB. :ivar files.UploadSessionFinishError.content_hash_mismatch: The content received by the Dropbox server in this call does not match the provided content hash.

Class Method	`lookup_failed`	Create an instance of this class set to the ``lookup_failed`` tag with value ``val``.
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_lookup_failed`	The session arguments are incorrect; the value explains the reason.
Method	`get_path`	Unable to save the uploaded contents to a file. Data has already been appended to the upload session. Please retry with empty data body and updated offset.
Method	`get_properties_error`	The supplied property group is invalid. The file has uploaded without property groups.
Method	`is_concurrent_session_data_not_allowed`	Check if the union tag is ``concurrent_session_data_not_allowed``.
Method	`is_concurrent_session_missing_data`	Check if the union tag is ``concurrent_session_missing_data``.
Method	`is_concurrent_session_not_closed`	Check if the union tag is ``concurrent_session_not_closed``.
Method	`is_content_hash_mismatch`	Check if the union tag is ``content_hash_mismatch``.
Method	`is_lookup_failed`	Check if the union tag is ``lookup_failed``.
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``.
Method	`is_too_many_shared_folder_targets`	Check if the union tag is ``too_many_shared_folder_targets``.
Method	`is_too_many_write_operations`	Check if the union tag is ``too_many_write_operations``.
Class Variable	`concurrent_session_data_not_allowed`	Undocumented
Class Variable	`concurrent_session_missing_data`	Undocumented
Class Variable	`concurrent_session_not_closed`	Undocumented
Class Variable	`content_hash_mismatch`	Undocumented
Class Variable	`other`	Undocumented
Class Variable	`payload_too_large`	Undocumented
Class Variable	`too_many_shared_folder_targets`	Undocumented
Class Variable	`too_many_write_operations`	Undocumented
Method	`_process_custom_annotations`	Undocumented
Class Variable	`_catch_all`	Undocumented

@classmethod
def lookup_failed(cls, val): (source) ¶

Create an instance of this class set to the ``lookup_failed`` tag with value ``val``. :param UploadSessionLookupError val: :rtype: UploadSessionFinishError

@classmethod
def path(cls, val): (source) ¶

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

@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: UploadSessionFinishError

def get_lookup_failed(self): (source) ¶

The session arguments are incorrect; the value explains the reason. Only call this if :meth:`is_lookup_failed` is true. :rtype: UploadSessionLookupError

def get_path(self): (source) ¶

Unable to save the uploaded contents to a file. Data has already been appended to the upload session. Please retry with empty data body and updated offset. Only call this if :meth:`is_path` is true. :rtype: WriteError

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_concurrent_session_data_not_allowed(self): (source) ¶

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

def is_concurrent_session_missing_data(self): (source) ¶

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

def is_concurrent_session_not_closed(self): (source) ¶

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

def is_content_hash_mismatch(self): (source) ¶

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

def is_lookup_failed(self): (source) ¶

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

def is_other(self): (source) ¶

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