Class UploadSessionLookupError
- java.lang.Object
-
- com.dropbox.core.v2.files.UploadSessionLookupError
-
public final class UploadSessionLookupError extends java.lang.Object
This class is an open 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.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 class
UploadSessionLookupError.Tag
Discriminating tag type forUploadSessionLookupError
.
-
Field Summary
Fields Modifier and Type Field Description static UploadSessionLookupError
CLOSED
You are attempting to append data to an upload session that has already been closed (i.e.static UploadSessionLookupError
NOT_CLOSED
The session must be closed before calling upload_session/finish_batch.static UploadSessionLookupError
NOT_FOUND
The upload session ID was not found or has expired.static UploadSessionLookupError
OTHER
Catch-all used for unknown tag values returned by the Dropbox servers.static UploadSessionLookupError
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 UploadSessionLookupError
incorrectOffset(UploadSessionOffsetError value)
Returns an instance ofUploadSessionLookupError
that has its tag set toUploadSessionLookupError.Tag.INCORRECT_OFFSET
.boolean
isClosed()
boolean
isIncorrectOffset()
Returnstrue
if this instance has the tagUploadSessionLookupError.Tag.INCORRECT_OFFSET
,false
otherwise.boolean
isNotClosed()
boolean
isNotFound()
boolean
isOther()
boolean
isTooLarge()
UploadSessionLookupError.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 UploadSessionLookupError NOT_FOUND
The upload session ID was not found or has expired. Upload sessions are valid for 48 hours.
-
CLOSED
public static final UploadSessionLookupError CLOSED
You are attempting to append data to an upload session that has already been closed (i.e. committed).
-
NOT_CLOSED
public static final UploadSessionLookupError NOT_CLOSED
The session must be closed before calling upload_session/finish_batch.
-
TOO_LARGE
public static final UploadSessionLookupError 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).
-
OTHER
public static final UploadSessionLookupError 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 Detail
-
tag
public UploadSessionLookupError.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 thisUploadSessionLookupError
.If a tag returned by the server is unrecognized by this SDK, the
UploadSessionLookupError.Tag.OTHER
value will be used.- Returns:
- the tag for this instance.
-
isNotFound
public boolean isNotFound()
- Returns:
true
if this instance is tagged asUploadSessionLookupError.Tag.NOT_FOUND
,false
otherwise.
-
isIncorrectOffset
public boolean isIncorrectOffset()
Returnstrue
if this instance has the tagUploadSessionLookupError.Tag.INCORRECT_OFFSET
,false
otherwise.- Returns:
true
if this instance is tagged asUploadSessionLookupError.Tag.INCORRECT_OFFSET
,false
otherwise.
-
incorrectOffset
public static UploadSessionLookupError incorrectOffset(UploadSessionOffsetError value)
Returns an instance ofUploadSessionLookupError
that has its tag set toUploadSessionLookupError.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
UploadSessionLookupError
with its tag set toUploadSessionLookupError.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
UploadSessionLookupError.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 asUploadSessionLookupError.Tag.CLOSED
,false
otherwise.
-
isNotClosed
public boolean isNotClosed()
- Returns:
true
if this instance is tagged asUploadSessionLookupError.Tag.NOT_CLOSED
,false
otherwise.
-
isTooLarge
public boolean isTooLarge()
- Returns:
true
if this instance is tagged asUploadSessionLookupError.Tag.TOO_LARGE
,false
otherwise.
-
isOther
public boolean isOther()
- Returns:
true
if this instance is tagged asUploadSessionLookupError.Tag.OTHER
,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
-
-