Class UploadError
- java.lang.Object
-
- com.dropbox.core.v2.files.UploadError
-
public final class UploadError extends java.lang.ObjectThis 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
OTHERvalue will be used.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classUploadError.TagDiscriminating tag type forUploadError.
-
Field Summary
Fields Modifier and Type Field Description static UploadErrorCONTENT_HASH_MISMATCHThe content received by the Dropbox server in this call does not match the provided content hash.static UploadErrorOTHERCatch-all used for unknown tag values returned by the Dropbox servers.static UploadErrorPAYLOAD_TOO_LARGEThe request payload must be at most 150 MB.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description booleanequals(java.lang.Object obj)UploadWriteFailedgetPathValue()Unable to save the uploaded contents to a file.InvalidPropertyGroupErrorgetPropertiesErrorValue()The supplied property group is invalid.inthashCode()booleanisContentHashMismatch()booleanisOther()booleanisPath()booleanisPayloadTooLarge()booleanisPropertiesError()static UploadErrorpath(UploadWriteFailed value)Returns an instance ofUploadErrorthat has its tag set toUploadError.Tag.PATH.static UploadErrorpropertiesError(InvalidPropertyGroupError value)Returns an instance ofUploadErrorthat has its tag set toUploadError.Tag.PROPERTIES_ERROR.UploadError.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
-
PAYLOAD_TOO_LARGE
public static final UploadError PAYLOAD_TOO_LARGE
The request payload must be at most 150 MB.
-
CONTENT_HASH_MISMATCH
public static final UploadError CONTENT_HASH_MISMATCH
The content received by the Dropbox server in this call does not match the provided content hash.
-
OTHER
public static final UploadError 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 UploadError.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 thisUploadError.If a tag returned by the server is unrecognized by this SDK, the
UploadError.Tag.OTHERvalue will be used.- Returns:
- the tag for this instance.
-
isPath
public boolean isPath()
- Returns:
trueif this instance is tagged asUploadError.Tag.PATH,falseotherwise.
-
path
public static UploadError path(UploadWriteFailed value)
Returns an instance ofUploadErrorthat has its tag set toUploadError.Tag.PATH.Unable to save the uploaded contents to a file.
- Parameters:
value- value to assign to this instance.- Returns:
- Instance of
UploadErrorwith its tag set toUploadError.Tag.PATH. - Throws:
java.lang.IllegalArgumentException- ifvalueisnull.
-
getPathValue
public UploadWriteFailed getPathValue()
Unable to save the uploaded contents to a file.This instance must be tagged as
UploadError.Tag.PATH.- Returns:
- The
UploadWriteFailedvalue associated with this instance ifisPath()istrue. - Throws:
java.lang.IllegalStateException- IfisPath()isfalse.
-
isPropertiesError
public boolean isPropertiesError()
- Returns:
trueif this instance is tagged asUploadError.Tag.PROPERTIES_ERROR,falseotherwise.
-
propertiesError
public static UploadError propertiesError(InvalidPropertyGroupError value)
Returns an instance ofUploadErrorthat has its tag set toUploadError.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
UploadErrorwith its tag set toUploadError.Tag.PROPERTIES_ERROR. - Throws:
java.lang.IllegalArgumentException- ifvalueisnull.
-
getPropertiesErrorValue
public InvalidPropertyGroupError getPropertiesErrorValue()
The supplied property group is invalid. The file has uploaded without property groups.This instance must be tagged as
UploadError.Tag.PROPERTIES_ERROR.- Returns:
- The
InvalidPropertyGroupErrorvalue associated with this instance ifisPropertiesError()istrue. - Throws:
java.lang.IllegalStateException- IfisPropertiesError()isfalse.
-
isPayloadTooLarge
public boolean isPayloadTooLarge()
- Returns:
trueif this instance is tagged asUploadError.Tag.PAYLOAD_TOO_LARGE,falseotherwise.
-
isContentHashMismatch
public boolean isContentHashMismatch()
- Returns:
trueif this instance is tagged asUploadError.Tag.CONTENT_HASH_MISMATCH,falseotherwise.
-
isOther
public boolean isOther()
- Returns:
trueif this instance is tagged asUploadError.Tag.OTHER,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
-
-