Class UploadSessionAppendError
- java.lang.Object
-
- com.dropbox.core.v2.files.UploadSessionAppendError
-
public final class UploadSessionAppendError extends java.lang.ObjectThis 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 classUploadSessionAppendError.TagDiscriminating tag type forUploadSessionAppendError.
-
Field Summary
Fields Modifier and Type Field Description static UploadSessionAppendErrorCLOSEDYou are attempting to append data to an upload session that has already been closed (i.e.static UploadSessionAppendErrorCONCURRENT_SESSION_INVALID_DATA_SIZEFor concurrent upload sessions, only chunks with size multiple of 4194304 bytes can be uploaded.static UploadSessionAppendErrorCONCURRENT_SESSION_INVALID_OFFSETFor concurrent upload sessions, offset needs to be multiple of 4194304 bytes.static UploadSessionAppendErrorCONTENT_HASH_MISMATCHThe content received by the Dropbox server in this call does not match the provided content hash.static UploadSessionAppendErrorNOT_CLOSEDThe session must be closed before calling upload_session/finish_batch.static UploadSessionAppendErrorNOT_FOUNDThe upload session ID was not found or has expired.static UploadSessionAppendErrorOTHERCatch-all used for unknown tag values returned by the Dropbox servers.static UploadSessionAppendErrorPAYLOAD_TOO_LARGEThe request payload must be at most 150 MB.static UploadSessionAppendErrorTOO_LARGEYou 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 booleanequals(java.lang.Object obj)UploadSessionOffsetErrorgetIncorrectOffsetValue()The specified offset was incorrect.inthashCode()static UploadSessionAppendErrorincorrectOffset(UploadSessionOffsetError value)Returns an instance ofUploadSessionAppendErrorthat has its tag set toUploadSessionAppendError.Tag.INCORRECT_OFFSET.booleanisClosed()booleanisConcurrentSessionInvalidDataSize()Returnstrueif this instance has the tagUploadSessionAppendError.Tag.CONCURRENT_SESSION_INVALID_DATA_SIZE,falseotherwise.booleanisConcurrentSessionInvalidOffset()Returnstrueif this instance has the tagUploadSessionAppendError.Tag.CONCURRENT_SESSION_INVALID_OFFSET,falseotherwise.booleanisContentHashMismatch()Returnstrueif this instance has the tagUploadSessionAppendError.Tag.CONTENT_HASH_MISMATCH,falseotherwise.booleanisIncorrectOffset()Returnstrueif this instance has the tagUploadSessionAppendError.Tag.INCORRECT_OFFSET,falseotherwise.booleanisNotClosed()booleanisNotFound()booleanisOther()booleanisPayloadTooLarge()Returnstrueif this instance has the tagUploadSessionAppendError.Tag.PAYLOAD_TOO_LARGE,falseotherwise.booleanisTooLarge()UploadSessionAppendError.Tagtag()Returns the tag for this instance.java.lang.StringtoString()java.lang.StringtoStringMultiline()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 aswitchstatement to properly handle the different values for thisUploadSessionAppendError.- Returns:
- the tag for this instance.
-
isNotFound
public boolean isNotFound()
- Returns:
trueif this instance is tagged asUploadSessionAppendError.Tag.NOT_FOUND,falseotherwise.
-
isIncorrectOffset
public boolean isIncorrectOffset()
Returnstrueif this instance has the tagUploadSessionAppendError.Tag.INCORRECT_OFFSET,falseotherwise.- Returns:
trueif this instance is tagged asUploadSessionAppendError.Tag.INCORRECT_OFFSET,falseotherwise.
-
incorrectOffset
public static UploadSessionAppendError incorrectOffset(UploadSessionOffsetError value)
Returns an instance ofUploadSessionAppendErrorthat 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
UploadSessionAppendErrorwith its tag set toUploadSessionAppendError.Tag.INCORRECT_OFFSET. - Throws:
java.lang.IllegalArgumentException- ifvalueisnull.
-
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
UploadSessionOffsetErrorvalue associated with this instance ifisIncorrectOffset()istrue. - Throws:
java.lang.IllegalStateException- IfisIncorrectOffset()isfalse.
-
isClosed
public boolean isClosed()
- Returns:
trueif this instance is tagged asUploadSessionAppendError.Tag.CLOSED,falseotherwise.
-
isNotClosed
public boolean isNotClosed()
- Returns:
trueif this instance is tagged asUploadSessionAppendError.Tag.NOT_CLOSED,falseotherwise.
-
isTooLarge
public boolean isTooLarge()
- Returns:
trueif this instance is tagged asUploadSessionAppendError.Tag.TOO_LARGE,falseotherwise.
-
isConcurrentSessionInvalidOffset
public boolean isConcurrentSessionInvalidOffset()
Returnstrueif this instance has the tagUploadSessionAppendError.Tag.CONCURRENT_SESSION_INVALID_OFFSET,falseotherwise.- Returns:
trueif this instance is tagged asUploadSessionAppendError.Tag.CONCURRENT_SESSION_INVALID_OFFSET,falseotherwise.
-
isConcurrentSessionInvalidDataSize
public boolean isConcurrentSessionInvalidDataSize()
Returnstrueif this instance has the tagUploadSessionAppendError.Tag.CONCURRENT_SESSION_INVALID_DATA_SIZE,falseotherwise.- Returns:
trueif this instance is tagged asUploadSessionAppendError.Tag.CONCURRENT_SESSION_INVALID_DATA_SIZE,falseotherwise.
-
isPayloadTooLarge
public boolean isPayloadTooLarge()
Returnstrueif this instance has the tagUploadSessionAppendError.Tag.PAYLOAD_TOO_LARGE,falseotherwise.- Returns:
trueif this instance is tagged asUploadSessionAppendError.Tag.PAYLOAD_TOO_LARGE,falseotherwise.
-
isOther
public boolean isOther()
- Returns:
trueif this instance is tagged asUploadSessionAppendError.Tag.OTHER,falseotherwise.
-
isContentHashMismatch
public boolean isContentHashMismatch()
Returnstrueif this instance has the tagUploadSessionAppendError.Tag.CONTENT_HASH_MISMATCH,falseotherwise.- Returns:
trueif this instance is tagged asUploadSessionAppendError.Tag.CONTENT_HASH_MISMATCH,falseotherwise.
-
hashCode
public int hashCode()
- Overrides:
hashCodein classjava.lang.Object
-
equals
public boolean equals(java.lang.Object obj)
- Overrides:
equalsin classjava.lang.Object
-
toString
public java.lang.String toString()
- Overrides:
toStringin 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
-
-