Package com.dropbox.core.v2.files

Class RelocationBatchLaunch

java.lang.Object

com.dropbox.core.v2.files.RelocationBatchLaunch

public final class RelocationBatchLaunch
extends Object

Result returned by DbxUserFilesRequests.copyBatch(java.util.List) or DbxUserFilesRequests.moveBatch(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	Description
static enum	RelocationBatchLaunch.Tag	Discriminating tag type for RelocationBatchLaunch.

Field Summary

Fields

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

Method Summary

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

OTHER

public static final RelocationBatchLaunch 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 Details

tag

public RelocationBatchLaunch.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 RelocationBatchLaunch.

If a tag returned by the server is unrecognized by this SDK, the RelocationBatchLaunch.Tag.OTHER value will be used.

Returns:

the tag for this instance.

isAsyncJobId

public boolean isAsyncJobId()

Returns true if this instance has the tag RelocationBatchLaunch.Tag.ASYNC_JOB_ID, false otherwise.

Returns:

true if this instance is tagged as RelocationBatchLaunch.Tag.ASYNC_JOB_ID, false otherwise.

asyncJobId

public static RelocationBatchLaunch asyncJobId(String value)

Returns an instance of RelocationBatchLaunch that has its tag set to RelocationBatchLaunch.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 RelocationBatchLaunch with its tag set to RelocationBatchLaunch.Tag.ASYNC_JOB_ID.

Throws:

IllegalArgumentException - if value is shorter than 1 or is null.

getAsyncJobIdValue

public 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 RelocationBatchLaunch.Tag.ASYNC_JOB_ID.

Returns:

The String value associated with this instance if isAsyncJobId() is true.

Throws:

IllegalStateException - If isAsyncJobId() is false.

isComplete

public boolean isComplete()

Returns true if this instance has the tag RelocationBatchLaunch.Tag.COMPLETE, false otherwise.

Returns:

true if this instance is tagged as RelocationBatchLaunch.Tag.COMPLETE, false otherwise.

complete

public static RelocationBatchLaunch complete(RelocationBatchResult value)

Returns an instance of RelocationBatchLaunch that has its tag set to RelocationBatchLaunch.Tag.COMPLETE.

None

Parameters:

value - value to assign to this instance.

Returns:

Instance of RelocationBatchLaunch with its tag set to RelocationBatchLaunch.Tag.COMPLETE.

Throws:

IllegalArgumentException - if value is null.

getCompleteValue

public RelocationBatchResult getCompleteValue()

This instance must be tagged as RelocationBatchLaunch.Tag.COMPLETE.

Returns:

The RelocationBatchResult value associated with this instance if isComplete() is true.

Throws:

IllegalStateException - If isComplete() is false.

isOther

public boolean isOther()

Returns true if this instance has the tag RelocationBatchLaunch.Tag.OTHER, false otherwise.

Returns:

true if this instance is tagged as RelocationBatchLaunch.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