Package com.dropbox.core.v2.files

Class UploadSessionFinishError

java.lang.Object

com.dropbox.core.v2.files.UploadSessionFinishError

public final class UploadSessionFinishError
extends Object

This class is an open tagged union. Tagged unions instances are always associated to a specific tag. This means only one of the isAbc() methods will return true. You can use tag() to determine the tag associated with this instance.

Open unions may be extended in the future with additional tags. If a new tag is introduced that this SDK does not recognized, the OTHER value will be used.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	UploadSessionFinishError.Tag	Discriminating tag type for UploadSessionFinishError.

Field Summary

Fields

Modifier and Type	Field	Description
static final UploadSessionFinishError	CONCURRENT_SESSION_DATA_NOT_ALLOWED	Uploading data not allowed when finishing concurrent upload session.
static final UploadSessionFinishError	CONCURRENT_SESSION_MISSING_DATA	Not all pieces of data were uploaded before trying to finish the session.
static final UploadSessionFinishError	CONCURRENT_SESSION_NOT_CLOSED	Concurrent upload sessions need to be closed before finishing.
static final UploadSessionFinishError	CONTENT_HASH_MISMATCH	The content received by the Dropbox server in this call does not match the provided content hash.
static final UploadSessionFinishError	ENCRYPTION_NOT_SUPPORTED	The file is required to be encrypted, which is not supported in our public API.
static final UploadSessionFinishError	OTHER	Catch-all used for unknown tag values returned by the Dropbox servers.
static final UploadSessionFinishError	PAYLOAD_TOO_LARGE	The request payload must be at most 150 MiB.
static final UploadSessionFinishError	TOO_MANY_SHARED_FOLDER_TARGETS	Field is deprecated.
static final UploadSessionFinishError	TOO_MANY_WRITE_OPERATIONS	There are too many write operations happening in the user's Dropbox.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
UploadSessionLookupError	getLookupFailedValue()	The session arguments are incorrect; the value explains the reason.
WriteError	getPathValue()	Unable to save the uploaded contents to a file.
InvalidPropertyGroupError	getPropertiesErrorValue()	The supplied property group is invalid.
int	hashCode()
boolean	isConcurrentSessionDataNotAllowed()	Returns true if this instance has the tag UploadSessionFinishError.Tag.CONCURRENT_SESSION_DATA_NOT_ALLOWED, false otherwise.
boolean	isConcurrentSessionMissingData()	Returns true if this instance has the tag UploadSessionFinishError.Tag.CONCURRENT_SESSION_MISSING_DATA, false otherwise.
boolean	isConcurrentSessionNotClosed()	Returns true if this instance has the tag UploadSessionFinishError.Tag.CONCURRENT_SESSION_NOT_CLOSED, false otherwise.
boolean	isContentHashMismatch()	Returns true if this instance has the tag UploadSessionFinishError.Tag.CONTENT_HASH_MISMATCH, false otherwise.
boolean	isEncryptionNotSupported()	Returns true if this instance has the tag UploadSessionFinishError.Tag.ENCRYPTION_NOT_SUPPORTED, false otherwise.
boolean	isLookupFailed()	Returns true if this instance has the tag UploadSessionFinishError.Tag.LOOKUP_FAILED, false otherwise.
boolean	isOther()	Returns true if this instance has the tag UploadSessionFinishError.Tag.OTHER, false otherwise.
boolean	isPath()	Returns true if this instance has the tag UploadSessionFinishError.Tag.PATH, false otherwise.
boolean	isPayloadTooLarge()	Returns true if this instance has the tag UploadSessionFinishError.Tag.PAYLOAD_TOO_LARGE, false otherwise.
boolean	isPropertiesError()	Returns true if this instance has the tag UploadSessionFinishError.Tag.PROPERTIES_ERROR, false otherwise.
boolean	isTooManySharedFolderTargets()	Returns true if this instance has the tag UploadSessionFinishError.Tag.TOO_MANY_SHARED_FOLDER_TARGETS, false otherwise.
boolean	isTooManyWriteOperations()	Returns true if this instance has the tag UploadSessionFinishError.Tag.TOO_MANY_WRITE_OPERATIONS, false otherwise.
static UploadSessionFinishError	lookupFailed(UploadSessionLookupError value)	Returns an instance of UploadSessionFinishError that has its tag set to UploadSessionFinishError.Tag.LOOKUP_FAILED.
static UploadSessionFinishError	path(WriteError value)	Returns an instance of UploadSessionFinishError that has its tag set to UploadSessionFinishError.Tag.PATH.
static UploadSessionFinishError	propertiesError(InvalidPropertyGroupError value)	Returns an instance of UploadSessionFinishError that has its tag set to UploadSessionFinishError.Tag.PROPERTIES_ERROR.
UploadSessionFinishError.Tag	tag()	Returns the tag for this instance.
String	toString()
String	toStringMultiline()	Returns a String representation of this object formatted for easier readability.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

TOO_MANY_SHARED_FOLDER_TARGETS

public static final UploadSessionFinishError TOO_MANY_SHARED_FOLDER_TARGETS

Field is deprecated. The batch request commits files into too many different shared folders. Please limit your batch request to files contained in a single shared folder.

TOO_MANY_WRITE_OPERATIONS

public static final UploadSessionFinishError TOO_MANY_WRITE_OPERATIONS

There are too many write operations happening in the user's Dropbox. You should retry uploading this file.

CONCURRENT_SESSION_DATA_NOT_ALLOWED

public static final UploadSessionFinishError CONCURRENT_SESSION_DATA_NOT_ALLOWED

Uploading data not allowed when finishing concurrent upload session.

CONCURRENT_SESSION_NOT_CLOSED

public static final UploadSessionFinishError CONCURRENT_SESSION_NOT_CLOSED

Concurrent upload sessions need to be closed before finishing.

CONCURRENT_SESSION_MISSING_DATA

public static final UploadSessionFinishError CONCURRENT_SESSION_MISSING_DATA

Not all pieces of data were uploaded before trying to finish the session.

PAYLOAD_TOO_LARGE

public static final UploadSessionFinishError PAYLOAD_TOO_LARGE

The request payload must be at most 150 MiB.

CONTENT_HASH_MISMATCH

public static final UploadSessionFinishError CONTENT_HASH_MISMATCH

The content received by the Dropbox server in this call does not match the provided content hash.

ENCRYPTION_NOT_SUPPORTED

public static final UploadSessionFinishError ENCRYPTION_NOT_SUPPORTED

The file is required to be encrypted, which is not supported in our public API.

OTHER

public static final UploadSessionFinishError OTHER

Catch-all used for unknown tag values returned by the Dropbox servers.

Receiving a catch-all value typically indicates this SDK version is not up to date. Consider updating your SDK version to handle the new tags.

Method Details

tag

public UploadSessionFinishError.Tag tag()

Returns the tag for this instance.

This class is a tagged union. Tagged unions instances are always associated to a specific tag. This means only one of the isXyz() methods will return true. Callers are recommended to use the tag value in a switch statement to properly handle the different values for this UploadSessionFinishError.

If a tag returned by the server is unrecognized by this SDK, the UploadSessionFinishError.Tag.OTHER value will be used.

Returns:

the tag for this instance.

isLookupFailed

public boolean isLookupFailed()

Returns true if this instance has the tag UploadSessionFinishError.Tag.LOOKUP_FAILED, false otherwise.

Returns:

true if this instance is tagged as UploadSessionFinishError.Tag.LOOKUP_FAILED, false otherwise.

lookupFailed

public static UploadSessionFinishError lookupFailed(UploadSessionLookupError value)

Returns an instance of UploadSessionFinishError that has its tag set to UploadSessionFinishError.Tag.LOOKUP_FAILED.

The session arguments are incorrect; the value explains the reason.

Parameters:

value - value to assign to this instance.

Returns:

Instance of UploadSessionFinishError with its tag set to UploadSessionFinishError.Tag.LOOKUP_FAILED.

Throws:

IllegalArgumentException - if value is null.

getLookupFailedValue

public UploadSessionLookupError getLookupFailedValue()

The session arguments are incorrect; the value explains the reason.

This instance must be tagged as UploadSessionFinishError.Tag.LOOKUP_FAILED.

Returns:

The UploadSessionLookupError value associated with this instance if isLookupFailed() is true.

Throws:

IllegalStateException - If isLookupFailed() is false.

isPath

public boolean isPath()

Returns true if this instance has the tag UploadSessionFinishError.Tag.PATH, false otherwise.

Returns:

true if this instance is tagged as UploadSessionFinishError.Tag.PATH, false otherwise.

path

public static UploadSessionFinishError path(WriteError value)

Returns an instance of UploadSessionFinishError that has its tag set to UploadSessionFinishError.Tag.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.

Parameters:

value - value to assign to this instance.

Returns:

Instance of UploadSessionFinishError with its tag set to UploadSessionFinishError.Tag.PATH.

Throws:

IllegalArgumentException - if value is null.

getPathValue

public WriteError getPathValue()

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.

This instance must be tagged as UploadSessionFinishError.Tag.PATH.

Returns:

The WriteError value associated with this instance if isPath() is true.

Throws:

IllegalStateException - If isPath() is false.

isPropertiesError

public boolean isPropertiesError()

Returns true if this instance has the tag UploadSessionFinishError.Tag.PROPERTIES_ERROR, false otherwise.

Returns:

true if this instance is tagged as UploadSessionFinishError.Tag.PROPERTIES_ERROR, false otherwise.

propertiesError

public static UploadSessionFinishError propertiesError(InvalidPropertyGroupError value)

Returns an instance of UploadSessionFinishError that has its tag set to UploadSessionFinishError.Tag.PROPERTIES_ERROR.

The supplied property group is invalid. The file has uploaded without property groups.

Parameters:

value - value to assign to this instance.

Returns:

Instance of UploadSessionFinishError with its tag set to UploadSessionFinishError.Tag.PROPERTIES_ERROR.

Throws:

IllegalArgumentException - if value is null.

getPropertiesErrorValue

public InvalidPropertyGroupError getPropertiesErrorValue()

The supplied property group is invalid. The file has uploaded without property groups.

This instance must be tagged as UploadSessionFinishError.Tag.PROPERTIES_ERROR.

Returns:

The InvalidPropertyGroupError value associated with this instance if isPropertiesError() is true.

Throws:

IllegalStateException - If isPropertiesError() is false.

isTooManySharedFolderTargets

public boolean isTooManySharedFolderTargets()

Returns true if this instance has the tag UploadSessionFinishError.Tag.TOO_MANY_SHARED_FOLDER_TARGETS, false otherwise.

Returns:

true if this instance is tagged as UploadSessionFinishError.Tag.TOO_MANY_SHARED_FOLDER_TARGETS, false otherwise.

isTooManyWriteOperations

public boolean isTooManyWriteOperations()

Returns true if this instance has the tag UploadSessionFinishError.Tag.TOO_MANY_WRITE_OPERATIONS, false otherwise.

Returns:

true if this instance is tagged as UploadSessionFinishError.Tag.TOO_MANY_WRITE_OPERATIONS, false otherwise.

isConcurrentSessionDataNotAllowed

public boolean isConcurrentSessionDataNotAllowed()

Returns true if this instance has the tag UploadSessionFinishError.Tag.CONCURRENT_SESSION_DATA_NOT_ALLOWED, false otherwise.

Returns:

true if this instance is tagged as UploadSessionFinishError.Tag.CONCURRENT_SESSION_DATA_NOT_ALLOWED, false otherwise.

isConcurrentSessionNotClosed

public boolean isConcurrentSessionNotClosed()

Returns true if this instance has the tag UploadSessionFinishError.Tag.CONCURRENT_SESSION_NOT_CLOSED, false otherwise.

Returns:

true if this instance is tagged as UploadSessionFinishError.Tag.CONCURRENT_SESSION_NOT_CLOSED, false otherwise.

isConcurrentSessionMissingData

public boolean isConcurrentSessionMissingData()

Returns true if this instance has the tag UploadSessionFinishError.Tag.CONCURRENT_SESSION_MISSING_DATA, false otherwise.

Returns:

true if this instance is tagged as UploadSessionFinishError.Tag.CONCURRENT_SESSION_MISSING_DATA, false otherwise.

isPayloadTooLarge

public boolean isPayloadTooLarge()

Returns true if this instance has the tag UploadSessionFinishError.Tag.PAYLOAD_TOO_LARGE, false otherwise.

Returns:

true if this instance is tagged as UploadSessionFinishError.Tag.PAYLOAD_TOO_LARGE, false otherwise.

isContentHashMismatch

public boolean isContentHashMismatch()

Returns true if this instance has the tag UploadSessionFinishError.Tag.CONTENT_HASH_MISMATCH, false otherwise.

Returns:

true if this instance is tagged as UploadSessionFinishError.Tag.CONTENT_HASH_MISMATCH, false otherwise.

isEncryptionNotSupported

public boolean isEncryptionNotSupported()

Returns true if this instance has the tag UploadSessionFinishError.Tag.ENCRYPTION_NOT_SUPPORTED, false otherwise.

Returns:

true if this instance is tagged as UploadSessionFinishError.Tag.ENCRYPTION_NOT_SUPPORTED, false otherwise.

isOther

public boolean isOther()

Returns true if this instance has the tag UploadSessionFinishError.Tag.OTHER, false otherwise.

Returns:

true if this instance is tagged as UploadSessionFinishError.Tag.OTHER, false otherwise.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

toStringMultiline

public String toStringMultiline()

Returns a String representation of this object formatted for easier readability.

The returned String may contain newlines.

Returns:

Formatted, multiline String representation of this object