Package com.dropbox.core.v2.files

Class RelocationBatchV2Launch

java.lang.Object

com.dropbox.core.v2.files.RelocationBatchV2Launch

public final class RelocationBatchV2Launch
extends Object

Result returned by DbxUserFilesRequests.copyBatchV2(java.util.List,boolean) or DbxUserFilesRequests.moveBatchV2(java.util.List) that may either launch an asynchronous job or complete synchronously.

This class is a 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.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	RelocationBatchV2Launch.Tag	Discriminating tag type for RelocationBatchV2Launch.

Method Summary

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

Method Details

tag

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

Returns:

the tag for this instance.

isAsyncJobId

public boolean isAsyncJobId()

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

Returns:

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

asyncJobId

public static RelocationBatchV2Launch asyncJobId(String value)

Returns an instance of RelocationBatchV2Launch that has its tag set to RelocationBatchV2Launch.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 RelocationBatchV2Launch with its tag set to RelocationBatchV2Launch.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 RelocationBatchV2Launch.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 RelocationBatchV2Launch.Tag.COMPLETE, false otherwise.

Returns:

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

complete

public static RelocationBatchV2Launch complete(RelocationBatchV2Result value)

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

None

Parameters:

value - value to assign to this instance.

Returns:

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

Throws:

IllegalArgumentException - if value is null.

getCompleteValue

public RelocationBatchV2Result getCompleteValue()

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

Returns:

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

Throws:

IllegalStateException - If isComplete() is false.

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