Package com.dropbox.core.v2.files

Class RelocationBatchErrorEntry

java.lang.Object

com.dropbox.core.v2.files.RelocationBatchErrorEntry

public final class RelocationBatchErrorEntry
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	Description
static enum	RelocationBatchErrorEntry.Tag	Discriminating tag type for RelocationBatchErrorEntry.

Field Summary

Fields

Modifier and Type	Field	Description
static final RelocationBatchErrorEntry	INTERNAL_ERROR	Something went wrong with the job on Dropbox's end.
static final RelocationBatchErrorEntry	OTHER	Catch-all used for unknown tag values returned by the Dropbox servers.
static final RelocationBatchErrorEntry	TOO_MANY_WRITE_OPERATIONS	There are too many write operations in user's Dropbox.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
RelocationError	getRelocationErrorValue()	User errors that retry won't help.
int	hashCode()
boolean	isInternalError()	Returns true if this instance has the tag RelocationBatchErrorEntry.Tag.INTERNAL_ERROR, false otherwise.
boolean	isOther()	Returns true if this instance has the tag RelocationBatchErrorEntry.Tag.OTHER, false otherwise.
boolean	isRelocationError()	Returns true if this instance has the tag RelocationBatchErrorEntry.Tag.RELOCATION_ERROR, false otherwise.
boolean	isTooManyWriteOperations()	Returns true if this instance has the tag RelocationBatchErrorEntry.Tag.TOO_MANY_WRITE_OPERATIONS, false otherwise.
static RelocationBatchErrorEntry	relocationError(RelocationError value)	Returns an instance of RelocationBatchErrorEntry that has its tag set to RelocationBatchErrorEntry.Tag.RELOCATION_ERROR.
RelocationBatchErrorEntry.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

INTERNAL_ERROR

public static final RelocationBatchErrorEntry INTERNAL_ERROR

Something went wrong with the job on Dropbox's end. You'll need to verify that the action you were taking succeeded, and if not, try again. This should happen very rarely.

TOO_MANY_WRITE_OPERATIONS

public static final RelocationBatchErrorEntry TOO_MANY_WRITE_OPERATIONS

There are too many write operations in user's Dropbox. Please retry this request.

OTHER

public static final RelocationBatchErrorEntry 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 RelocationBatchErrorEntry.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 RelocationBatchErrorEntry.

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

Returns:

the tag for this instance.

isRelocationError

public boolean isRelocationError()

Returns true if this instance has the tag RelocationBatchErrorEntry.Tag.RELOCATION_ERROR, false otherwise.

Returns:

true if this instance is tagged as RelocationBatchErrorEntry.Tag.RELOCATION_ERROR, false otherwise.

relocationError

public static RelocationBatchErrorEntry relocationError(RelocationError value)

Returns an instance of RelocationBatchErrorEntry that has its tag set to RelocationBatchErrorEntry.Tag.RELOCATION_ERROR.

User errors that retry won't help.

Parameters:

value - value to assign to this instance.

Returns:

Instance of RelocationBatchErrorEntry with its tag set to RelocationBatchErrorEntry.Tag.RELOCATION_ERROR.

Throws:

IllegalArgumentException - if value is null.

getRelocationErrorValue

public RelocationError getRelocationErrorValue()

User errors that retry won't help.

This instance must be tagged as RelocationBatchErrorEntry.Tag.RELOCATION_ERROR.

Returns:

The RelocationError value associated with this instance if isRelocationError() is true.

Throws:

IllegalStateException - If isRelocationError() is false.

isInternalError

public boolean isInternalError()

Returns true if this instance has the tag RelocationBatchErrorEntry.Tag.INTERNAL_ERROR, false otherwise.

Returns:

true if this instance is tagged as RelocationBatchErrorEntry.Tag.INTERNAL_ERROR, false otherwise.

isTooManyWriteOperations

public boolean isTooManyWriteOperations()

Returns true if this instance has the tag RelocationBatchErrorEntry.Tag.TOO_MANY_WRITE_OPERATIONS, false otherwise.

Returns:

true if this instance is tagged as RelocationBatchErrorEntry.Tag.TOO_MANY_WRITE_OPERATIONS, false otherwise.

isOther

public boolean isOther()

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

Returns:

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