UploadSessionFinishBatchLaunch (Official Dropbox Java SDK 4.0.0 API)

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

```
public final class UploadSessionFinishBatchLaunch
extends java.lang.Object
```
Result returned by DbxUserFilesRequests.uploadSessionFinishBatch(java.util.List) that may either launch an asynchronous job or complete synchronously.
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 UploadSessionFinishBatchLaunch.Tag
Discriminating tag type for UploadSessionFinishBatchLaunch.

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

Field Summary

Fields
Modifier and Type Field and Description

static UploadSessionFinishBatchLaunch OTHER
Catch-all used for unknown tag values returned by the Dropbox servers.

Fields
Modifier and Type	Field and Description
`static UploadSessionFinishBatchLaunch`	`OTHER` Catch-all used for unknown tag values returned by the Dropbox servers.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static UploadSessionFinishBatchLaunch`	`asyncJobId(java.lang.String value)` Returns an instance of `UploadSessionFinishBatchLaunch` that has its tag set to `UploadSessionFinishBatchLaunch.Tag.ASYNC_JOB_ID`.
`static UploadSessionFinishBatchLaunch`	`complete(UploadSessionFinishBatchResult value)` Returns an instance of `UploadSessionFinishBatchLaunch` that has its tag set to `UploadSessionFinishBatchLaunch.Tag.COMPLETE`.
`boolean`	`equals(java.lang.Object obj)`
`java.lang.String`	`getAsyncJobIdValue()` This response indicates that the processing is asynchronous.
`UploadSessionFinishBatchResult`	`getCompleteValue()` This instance must be tagged as `UploadSessionFinishBatchLaunch.Tag.COMPLETE`.
`int`	`hashCode()`
`boolean`	`isAsyncJobId()` Returns `true` if this instance has the tag `UploadSessionFinishBatchLaunch.Tag.ASYNC_JOB_ID`, `false` otherwise.
`boolean`	`isComplete()` Returns `true` if this instance has the tag `UploadSessionFinishBatchLaunch.Tag.COMPLETE`, `false` otherwise.
`boolean`	`isOther()` Returns `true` if this instance has the tag `UploadSessionFinishBatchLaunch.Tag.OTHER`, `false` otherwise.
`UploadSessionFinishBatchLaunch.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.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - OTHER
```
public static final UploadSessionFinishBatchLaunch 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 UploadSessionFinishBatchLaunch.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 UploadSessionFinishBatchLaunch.
    
    If a tag returned by the server is unrecognized by this SDK, the UploadSessionFinishBatchLaunch.Tag.OTHER value will be used.
    
    Returns:
    
    the tag for this instance.
  - isAsyncJobId
```
public boolean isAsyncJobId()
```
    Returns true if this instance has the tag UploadSessionFinishBatchLaunch.Tag.ASYNC_JOB_ID, false otherwise.
    
    Returns:
    
    true if this instance is tagged as UploadSessionFinishBatchLaunch.Tag.ASYNC_JOB_ID, false otherwise.
  - asyncJobId
```
public static UploadSessionFinishBatchLaunch asyncJobId(java.lang.String value)
```
    Returns an instance of UploadSessionFinishBatchLaunch that has its tag set to UploadSessionFinishBatchLaunch.Tag.ASYNC_JOB_ID.
    This response indicates that the processing is asynchronous. The string is an id that can be used to obtain the status of the asynchronous job.
    
    Parameters:
    
    value - value to assign to this instance.
    
    Returns:
    
    Instance of UploadSessionFinishBatchLaunch with its tag set to UploadSessionFinishBatchLaunch.Tag.ASYNC_JOB_ID.
    
    Throws:
    
    java.lang.IllegalArgumentException - if value is shorter than 1 or is null.
  - getAsyncJobIdValue
```
public java.lang.String getAsyncJobIdValue()
```
    This response indicates that the processing is asynchronous. The string is an id that can be used to obtain the status of the asynchronous job.
    This instance must be tagged as UploadSessionFinishBatchLaunch.Tag.ASYNC_JOB_ID.
    
    Returns:
    
    The String value associated with this instance if isAsyncJobId() is true.
    
    Throws:
    
    java.lang.IllegalStateException - If isAsyncJobId() is false.
  - isComplete
```
public boolean isComplete()
```
    Returns true if this instance has the tag UploadSessionFinishBatchLaunch.Tag.COMPLETE, false otherwise.
    
    Returns:
    
    true if this instance is tagged as UploadSessionFinishBatchLaunch.Tag.COMPLETE, false otherwise.
  - complete
```
public static UploadSessionFinishBatchLaunch complete(UploadSessionFinishBatchResult value)
```
    Returns an instance of UploadSessionFinishBatchLaunch that has its tag set to UploadSessionFinishBatchLaunch.Tag.COMPLETE.
    None
    
    Parameters:
    
    value - value to assign to this instance.
    
    Returns:
    
    Instance of UploadSessionFinishBatchLaunch with its tag set to UploadSessionFinishBatchLaunch.Tag.COMPLETE.
    
    Throws:
    
    java.lang.IllegalArgumentException - if value is null.
  - getCompleteValue
```
public UploadSessionFinishBatchResult getCompleteValue()
```
    This instance must be tagged as UploadSessionFinishBatchLaunch.Tag.COMPLETE.
    
    Returns:
    
    The UploadSessionFinishBatchResult value associated with this instance if isComplete() is true.
    
    Throws:
    
    java.lang.IllegalStateException - If isComplete() is false.
  - isOther
```
public boolean isOther()
```
    Returns true if this instance has the tag UploadSessionFinishBatchLaunch.Tag.OTHER, false otherwise.
    
    Returns:
    
    true if this instance is tagged as UploadSessionFinishBatchLaunch.Tag.OTHER, false otherwise.
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.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

Class UploadSessionFinishBatchLaunch

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

OTHER

Method Detail

tag

isAsyncJobId

asyncJobId

getAsyncJobIdValue

isComplete

complete

getCompleteValue

isOther

hashCode

equals

toString

toStringMultiline