Package com.dropbox.core.v2.files

Class DeleteBatchLaunch

java.lang.Object

com.dropbox.core.v2.files.DeleteBatchLaunch

public final class DeleteBatchLaunch
extends Object

Result returned by DbxUserFilesRequests.deleteBatch(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	DeleteBatchLaunch.Tag	Discriminating tag type for DeleteBatchLaunch.

Field Summary

Fields

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

Method Summary

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

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

Returns:

the tag for this instance.

isAsyncJobId

public boolean isAsyncJobId()

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

Returns:

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

asyncJobId

public static DeleteBatchLaunch asyncJobId(String value)

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

Returns:

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

complete

public static DeleteBatchLaunch complete(DeleteBatchResult value)

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

None

Parameters:

value - value to assign to this instance.

Returns:

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

Throws:

IllegalArgumentException - if value is null.

getCompleteValue

public DeleteBatchResult getCompleteValue()

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

Returns:

The DeleteBatchResult 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 DeleteBatchLaunch.Tag.OTHER, false otherwise.

Returns:

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