Package com.dropbox.core.v2.files

Class UploadSessionAppendError

java.lang.Object

com.dropbox.core.v2.files.UploadSessionAppendError

public final class UploadSessionAppendError
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	UploadSessionAppendError.Tag	Discriminating tag type for UploadSessionAppendError.

Field Summary

Fields

Modifier and Type	Field	Description
static final UploadSessionAppendError	CLOSED	You are attempting to append data to an upload session that has already been closed (i.e.
static final UploadSessionAppendError	CONCURRENT_SESSION_INVALID_DATA_SIZE	For concurrent upload sessions, only chunks with size multiple of 2^22 (4,194,304) bytes can be uploaded.
static final UploadSessionAppendError	CONCURRENT_SESSION_INVALID_OFFSET	For concurrent upload sessions, offset needs to be multiple of 2^22 (4,194,304) bytes.
static final UploadSessionAppendError	CONTENT_HASH_MISMATCH	The content received by the Dropbox server in this call does not match the provided content hash.
static final UploadSessionAppendError	NOT_FOUND	The upload session ID was not found or has expired.
static final UploadSessionAppendError	OTHER	Catch-all used for unknown tag values returned by the Dropbox servers.
static final UploadSessionAppendError	PAYLOAD_TOO_LARGE	The request payload must be at most 150 MiB.
static final UploadSessionAppendError	TOO_LARGE	You can not append to the upload session because the size of a file should not exceed the max file size limit (i.e.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
UploadSessionOffsetError	getIncorrectOffsetValue()	The specified offset was incorrect.
int	hashCode()
static UploadSessionAppendError	incorrectOffset(UploadSessionOffsetError value)	Returns an instance of UploadSessionAppendError that has its tag set to UploadSessionAppendError.Tag.INCORRECT_OFFSET.
boolean	isClosed()	Returns true if this instance has the tag UploadSessionAppendError.Tag.CLOSED, false otherwise.
boolean	isConcurrentSessionInvalidDataSize()	Returns true if this instance has the tag UploadSessionAppendError.Tag.CONCURRENT_SESSION_INVALID_DATA_SIZE, false otherwise.
boolean	isConcurrentSessionInvalidOffset()	Returns true if this instance has the tag UploadSessionAppendError.Tag.CONCURRENT_SESSION_INVALID_OFFSET, false otherwise.
boolean	isContentHashMismatch()	Returns true if this instance has the tag UploadSessionAppendError.Tag.CONTENT_HASH_MISMATCH, false otherwise.
boolean	isIncorrectOffset()	Returns true if this instance has the tag UploadSessionAppendError.Tag.INCORRECT_OFFSET, false otherwise.
boolean	isNotFound()	Returns true if this instance has the tag UploadSessionAppendError.Tag.NOT_FOUND, false otherwise.
boolean	isOther()	Returns true if this instance has the tag UploadSessionAppendError.Tag.OTHER, false otherwise.
boolean	isPayloadTooLarge()	Returns true if this instance has the tag UploadSessionAppendError.Tag.PAYLOAD_TOO_LARGE, false otherwise.
boolean	isTooLarge()	Returns true if this instance has the tag UploadSessionAppendError.Tag.TOO_LARGE, false otherwise.
UploadSessionAppendError.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

NOT_FOUND

public static final UploadSessionAppendError NOT_FOUND

The upload session ID was not found or has expired. Upload sessions are valid for 7 days.

CLOSED

public static final UploadSessionAppendError CLOSED

You are attempting to append data to an upload session that has already been closed (i.e. committed).

TOO_LARGE

public static final UploadSessionAppendError TOO_LARGE

You can not append to the upload session because the size of a file should not exceed the max file size limit (i.e. 2^41 - 2^22 or 2,199,019,061,248 bytes).

CONCURRENT_SESSION_INVALID_OFFSET

public static final UploadSessionAppendError CONCURRENT_SESSION_INVALID_OFFSET

For concurrent upload sessions, offset needs to be multiple of 2^22 (4,194,304) bytes.

CONCURRENT_SESSION_INVALID_DATA_SIZE

public static final UploadSessionAppendError CONCURRENT_SESSION_INVALID_DATA_SIZE

For concurrent upload sessions, only chunks with size multiple of 2^22 (4,194,304) bytes can be uploaded.

PAYLOAD_TOO_LARGE

public static final UploadSessionAppendError PAYLOAD_TOO_LARGE

The request payload must be at most 150 MiB.

CONTENT_HASH_MISMATCH

public static final UploadSessionAppendError CONTENT_HASH_MISMATCH

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

OTHER

public static final UploadSessionAppendError 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 UploadSessionAppendError.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 UploadSessionAppendError.

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

Returns:

the tag for this instance.

isNotFound

public boolean isNotFound()

Returns true if this instance has the tag UploadSessionAppendError.Tag.NOT_FOUND, false otherwise.

Returns:

true if this instance is tagged as UploadSessionAppendError.Tag.NOT_FOUND, false otherwise.

isIncorrectOffset

public boolean isIncorrectOffset()

Returns true if this instance has the tag UploadSessionAppendError.Tag.INCORRECT_OFFSET, false otherwise.

Returns:

true if this instance is tagged as UploadSessionAppendError.Tag.INCORRECT_OFFSET, false otherwise.

incorrectOffset

public static UploadSessionAppendError incorrectOffset(UploadSessionOffsetError value)

Returns an instance of UploadSessionAppendError that has its tag set to UploadSessionAppendError.Tag.INCORRECT_OFFSET.

The specified offset was incorrect. See the value for the correct offset. This error may occur when a previous request was received and processed successfully but the client did not receive the response, e.g. due to a network error.

Parameters:

value - value to assign to this instance.

Returns:

Instance of UploadSessionAppendError with its tag set to UploadSessionAppendError.Tag.INCORRECT_OFFSET.

Throws:

IllegalArgumentException - if value is null.

getIncorrectOffsetValue

public UploadSessionOffsetError getIncorrectOffsetValue()

The specified offset was incorrect. See the value for the correct offset. This error may occur when a previous request was received and processed successfully but the client did not receive the response, e.g. due to a network error.

This instance must be tagged as UploadSessionAppendError.Tag.INCORRECT_OFFSET.

Returns:

The UploadSessionOffsetError value associated with this instance if isIncorrectOffset() is true.

Throws:

IllegalStateException - If isIncorrectOffset() is false.

isClosed

public boolean isClosed()

Returns true if this instance has the tag UploadSessionAppendError.Tag.CLOSED, false otherwise.

Returns:

true if this instance is tagged as UploadSessionAppendError.Tag.CLOSED, false otherwise.

isTooLarge

public boolean isTooLarge()

Returns true if this instance has the tag UploadSessionAppendError.Tag.TOO_LARGE, false otherwise.

Returns:

true if this instance is tagged as UploadSessionAppendError.Tag.TOO_LARGE, false otherwise.

isConcurrentSessionInvalidOffset

public boolean isConcurrentSessionInvalidOffset()

Returns true if this instance has the tag UploadSessionAppendError.Tag.CONCURRENT_SESSION_INVALID_OFFSET, false otherwise.

Returns:

true if this instance is tagged as UploadSessionAppendError.Tag.CONCURRENT_SESSION_INVALID_OFFSET, false otherwise.

isConcurrentSessionInvalidDataSize

public boolean isConcurrentSessionInvalidDataSize()

Returns true if this instance has the tag UploadSessionAppendError.Tag.CONCURRENT_SESSION_INVALID_DATA_SIZE, false otherwise.

Returns:

true if this instance is tagged as UploadSessionAppendError.Tag.CONCURRENT_SESSION_INVALID_DATA_SIZE, false otherwise.

isPayloadTooLarge

public boolean isPayloadTooLarge()

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

Returns:

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

isContentHashMismatch

public boolean isContentHashMismatch()

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

Returns:

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

isOther

public boolean isOther()

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

Returns:

true if this instance is tagged as UploadSessionAppendError.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