Class UploadSessionAppendError
- java.lang.Object
-
- com.dropbox.core.v2.files.UploadSessionAppendError
-
public final class UploadSessionAppendError extends java.lang.Object
This class is a tagged union. Tagged unions instances are always associated to a specific tag. This means only one of theisAbc()
methods will returntrue
. You can usetag()
to determine the tag associated with this instance.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
UploadSessionAppendError.Tag
Discriminating tag type forUploadSessionAppendError
.
-
Field Summary
Fields Modifier and Type Field Description static UploadSessionAppendError
CLOSED
You are attempting to append data to an upload session that has already been closed (i.e.static UploadSessionAppendError
CONCURRENT_SESSION_INVALID_DATA_SIZE
For concurrent upload sessions, only chunks with size multiple of 4194304 bytes can be uploaded.static UploadSessionAppendError
CONCURRENT_SESSION_INVALID_OFFSET
For concurrent upload sessions, offset needs to be multiple of 4194304 bytes.static UploadSessionAppendError
CONTENT_HASH_MISMATCH
The content received by the Dropbox server in this call does not match the provided content hash.static UploadSessionAppendError
NOT_CLOSED
The session must be closed before calling upload_session/finish_batch.static UploadSessionAppendError
NOT_FOUND
The upload session ID was not found or has expired.static UploadSessionAppendError
OTHER
Catch-all used for unknown tag values returned by the Dropbox servers.static UploadSessionAppendError
PAYLOAD_TOO_LARGE
The request payload must be at most 150 MB.static UploadSessionAppendError
TOO_LARGE
You can not append to the upload session because the size of a file should not reach the max file size limit (i.e.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
equals(java.lang.Object obj)
UploadSessionOffsetError
getIncorrectOffsetValue()
The specified offset was incorrect.int
hashCode()
static UploadSessionAppendError
incorrectOffset(UploadSessionOffsetError value)
Returns an instance ofUploadSessionAppendError
that has its tag set toUploadSessionAppendError.Tag.INCORRECT_OFFSET
.boolean
isClosed()
boolean
isConcurrentSessionInvalidDataSize()
Returnstrue
if this instance has the tagUploadSessionAppendError.Tag.CONCURRENT_SESSION_INVALID_DATA_SIZE
,false
otherwise.boolean
isConcurrentSessionInvalidOffset()
Returnstrue
if this instance has the tagUploadSessionAppendError.Tag.CONCURRENT_SESSION_INVALID_OFFSET
,false
otherwise.boolean
isContentHashMismatch()
Returnstrue
if this instance has the tagUploadSessionAppendError.Tag.CONTENT_HASH_MISMATCH
,false
otherwise.boolean
isIncorrectOffset()
Returnstrue
if this instance has the tagUploadSessionAppendError.Tag.INCORRECT_OFFSET
,false
otherwise.boolean
isNotClosed()
boolean
isNotFound()
boolean
isOther()
boolean
isPayloadTooLarge()
Returnstrue
if this instance has the tagUploadSessionAppendError.Tag.PAYLOAD_TOO_LARGE
,false
otherwise.boolean
isTooLarge()
UploadSessionAppendError.Tag
tag()
Returns the tag for this instance.java.lang.String
toString()
java.lang.String
toStringMultiline()
Returns a String representation of this object formatted for easier readability.
-
-
-
Field Detail
-
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).
-
NOT_CLOSED
public static final UploadSessionAppendError NOT_CLOSED
The session must be closed before calling upload_session/finish_batch.
-
TOO_LARGE
public static final UploadSessionAppendError TOO_LARGE
You can not append to the upload session because the size of a file should not reach the max file size limit (i.e. 350GB).
-
CONCURRENT_SESSION_INVALID_OFFSET
public static final UploadSessionAppendError CONCURRENT_SESSION_INVALID_OFFSET
For concurrent upload sessions, offset needs to be multiple of 4194304 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 4194304 bytes can be uploaded.
-
PAYLOAD_TOO_LARGE
public static final UploadSessionAppendError PAYLOAD_TOO_LARGE
The request payload must be at most 150 MB.
-
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.
-
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.
-
-
Method Detail
-
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 returntrue
. Callers are recommended to use the tag value in aswitch
statement to properly handle the different values for thisUploadSessionAppendError
.- Returns:
- the tag for this instance.
-
isNotFound
public boolean isNotFound()
- Returns:
true
if this instance is tagged asUploadSessionAppendError.Tag.NOT_FOUND
,false
otherwise.
-
isIncorrectOffset
public boolean isIncorrectOffset()
Returnstrue
if this instance has the tagUploadSessionAppendError.Tag.INCORRECT_OFFSET
,false
otherwise.- Returns:
true
if this instance is tagged asUploadSessionAppendError.Tag.INCORRECT_OFFSET
,false
otherwise.
-
incorrectOffset
public static UploadSessionAppendError incorrectOffset(UploadSessionOffsetError value)
Returns an instance ofUploadSessionAppendError
that has its tag set toUploadSessionAppendError.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 toUploadSessionAppendError.Tag.INCORRECT_OFFSET
. - Throws:
java.lang.IllegalArgumentException
- ifvalue
isnull
.
-
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 ifisIncorrectOffset()
istrue
. - Throws:
java.lang.IllegalStateException
- IfisIncorrectOffset()
isfalse
.
-
isClosed
public boolean isClosed()
- Returns:
true
if this instance is tagged asUploadSessionAppendError.Tag.CLOSED
,false
otherwise.
-
isNotClosed
public boolean isNotClosed()
- Returns:
true
if this instance is tagged asUploadSessionAppendError.Tag.NOT_CLOSED
,false
otherwise.
-
isTooLarge
public boolean isTooLarge()
- Returns:
true
if this instance is tagged asUploadSessionAppendError.Tag.TOO_LARGE
,false
otherwise.
-
isConcurrentSessionInvalidOffset
public boolean isConcurrentSessionInvalidOffset()
Returnstrue
if this instance has the tagUploadSessionAppendError.Tag.CONCURRENT_SESSION_INVALID_OFFSET
,false
otherwise.- Returns:
true
if this instance is tagged asUploadSessionAppendError.Tag.CONCURRENT_SESSION_INVALID_OFFSET
,false
otherwise.
-
isConcurrentSessionInvalidDataSize
public boolean isConcurrentSessionInvalidDataSize()
Returnstrue
if this instance has the tagUploadSessionAppendError.Tag.CONCURRENT_SESSION_INVALID_DATA_SIZE
,false
otherwise.- Returns:
true
if this instance is tagged asUploadSessionAppendError.Tag.CONCURRENT_SESSION_INVALID_DATA_SIZE
,false
otherwise.
-
isPayloadTooLarge
public boolean isPayloadTooLarge()
Returnstrue
if this instance has the tagUploadSessionAppendError.Tag.PAYLOAD_TOO_LARGE
,false
otherwise.- Returns:
true
if this instance is tagged asUploadSessionAppendError.Tag.PAYLOAD_TOO_LARGE
,false
otherwise.
-
isOther
public boolean isOther()
- Returns:
true
if this instance is tagged asUploadSessionAppendError.Tag.OTHER
,false
otherwise.
-
isContentHashMismatch
public boolean isContentHashMismatch()
Returnstrue
if this instance has the tagUploadSessionAppendError.Tag.CONTENT_HASH_MISMATCH
,false
otherwise.- Returns:
true
if this instance is tagged asUploadSessionAppendError.Tag.CONTENT_HASH_MISMATCH
,false
otherwise.
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
equals
public boolean equals(java.lang.Object obj)
- Overrides:
equals
in classjava.lang.Object
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
toStringMultiline
public java.lang.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
-
-