UploadSessionFinishError (Official Dropbox Java SDK 2.1.2 API)

java.lang.Object
- com.dropbox.core.v2.files.UploadSessionFinishError

```
public final class UploadSessionFinishError
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 and Description

static class UploadSessionFinishError.Tag
Discriminating tag type for UploadSessionFinishError.

Nested Classes
Modifier and Type	Class and Description
`static class`	`UploadSessionFinishError.Tag` Discriminating tag type for `UploadSessionFinishError`.

Field Summary

Fields
Modifier and Type	Field and Description
`static UploadSessionFinishError`	`OTHER` Catch-all used for unknown tag values returned by the Dropbox servers.
`static UploadSessionFinishError`	`TOO_MANY_SHARED_FOLDER_TARGETS` The batch request commits files into too many different shared folders.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`UploadSessionLookupError`	`getLookupFailedValue()` The session arguments are incorrect; the value explains the reason.
`WriteError`	`getPathValue()` Unable to save the uploaded contents to a file.
`int`	`hashCode()`
`boolean`	`isLookupFailed()` Returns `true` if this instance has the tag `UploadSessionFinishError.Tag.LOOKUP_FAILED`, `false` otherwise.
`boolean`	`isOther()` Returns `true` if this instance has the tag `UploadSessionFinishError.Tag.OTHER`, `false` otherwise.
`boolean`	`isPath()` Returns `true` if this instance has the tag `UploadSessionFinishError.Tag.PATH`, `false` otherwise.
`boolean`	`isTooManySharedFolderTargets()` Returns `true` if this instance has the tag `UploadSessionFinishError.Tag.TOO_MANY_SHARED_FOLDER_TARGETS`, `false` otherwise.
`static UploadSessionFinishError`	`lookupFailed(UploadSessionLookupError value)` Returns an instance of `UploadSessionFinishError` that has its tag set to `UploadSessionFinishError.Tag.LOOKUP_FAILED`.
`static UploadSessionFinishError`	`path(WriteError value)` Returns an instance of `UploadSessionFinishError` that has its tag set to `UploadSessionFinishError.Tag.PATH`.
`UploadSessionFinishError.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 Detail
  - TOO_MANY_SHARED_FOLDER_TARGETS
```
public static final UploadSessionFinishError TOO_MANY_SHARED_FOLDER_TARGETS
```
    The batch request commits files into too many different shared folders. Please limit your batch request to files contained in a single shared folder.
  - OTHER
```
public static final UploadSessionFinishError 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 UploadSessionFinishError.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 UploadSessionFinishError.
    
    If a tag returned by the server is unrecognized by this SDK, the UploadSessionFinishError.Tag.OTHER value will be used.
    
    Returns:
    
    the tag for this instance.
  - isLookupFailed
```
public boolean isLookupFailed()
```
    Returns true if this instance has the tag UploadSessionFinishError.Tag.LOOKUP_FAILED, false otherwise.
    
    Returns:
    
    true if this instance is tagged as UploadSessionFinishError.Tag.LOOKUP_FAILED, false otherwise.
  - lookupFailed
```
public static UploadSessionFinishError lookupFailed(UploadSessionLookupError value)
```
    Returns an instance of UploadSessionFinishError that has its tag set to UploadSessionFinishError.Tag.LOOKUP_FAILED.
    The session arguments are incorrect; the value explains the reason.
    
    Parameters:
    
    value - value to assign to this instance.
    
    Returns:
    
    Instance of UploadSessionFinishError with its tag set to UploadSessionFinishError.Tag.LOOKUP_FAILED.
    
    Throws:
    
    IllegalArgumentException - if value is null.
  - getLookupFailedValue
```
public UploadSessionLookupError getLookupFailedValue()
```
    The session arguments are incorrect; the value explains the reason.
    This instance must be tagged as UploadSessionFinishError.Tag.LOOKUP_FAILED.
    
    Returns:
    
    The UploadSessionLookupError value associated with this instance if isLookupFailed() is true.
    
    Throws:
    
    IllegalStateException - If isLookupFailed() is false.
  - isPath
```
public boolean isPath()
```
    Returns true if this instance has the tag UploadSessionFinishError.Tag.PATH, false otherwise.
    
    Returns:
    
    true if this instance is tagged as UploadSessionFinishError.Tag.PATH, false otherwise.
  - path
```
public static UploadSessionFinishError path(WriteError value)
```
    Returns an instance of UploadSessionFinishError that has its tag set to UploadSessionFinishError.Tag.PATH.
    Unable to save the uploaded contents to a file.
    
    Parameters:
    
    value - value to assign to this instance.
    
    Returns:
    
    Instance of UploadSessionFinishError with its tag set to UploadSessionFinishError.Tag.PATH.
    
    Throws:
    
    IllegalArgumentException - if value is null.
  - getPathValue
```
public WriteError getPathValue()
```
    Unable to save the uploaded contents to a file.
    This instance must be tagged as UploadSessionFinishError.Tag.PATH.
    
    Returns:
    
    The WriteError value associated with this instance if isPath() is true.
    
    Throws:
    
    IllegalStateException - If isPath() is false.
  - isTooManySharedFolderTargets
```
public boolean isTooManySharedFolderTargets()
```
    Returns true if this instance has the tag UploadSessionFinishError.Tag.TOO_MANY_SHARED_FOLDER_TARGETS, false otherwise.
    
    Returns:
    
    true if this instance is tagged as UploadSessionFinishError.Tag.TOO_MANY_SHARED_FOLDER_TARGETS, false otherwise.
  - isOther
```
public boolean isOther()
```
    Returns true if this instance has the tag UploadSessionFinishError.Tag.OTHER, false otherwise.
    
    Returns:
    
    true if this instance is tagged as UploadSessionFinishError.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

Class UploadSessionFinishError

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

TOO_MANY_SHARED_FOLDER_TARGETS

OTHER

Method Detail

tag

isLookupFailed

lookupFailed

getLookupFailedValue

isPath

path

getPathValue

isTooManySharedFolderTargets

isOther

hashCode

equals

toString

toStringMultiline