Package com.dropbox.core.v2.team

Class MembersAddJobStatusV2Result

java.lang.Object

com.dropbox.core.v2.team.MembersAddJobStatusV2Result

public final class MembersAddJobStatusV2Result
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	MembersAddJobStatusV2Result.Tag	Discriminating tag type for MembersAddJobStatusV2Result.

Field Summary

Fields

Modifier and Type	Field	Description
static final MembersAddJobStatusV2Result	IN_PROGRESS	The asynchronous job is still in progress.
static final MembersAddJobStatusV2Result	OTHER	Catch-all used for unknown tag values returned by the Dropbox servers.

Method Summary

Modifier and Type	Method	Description
static MembersAddJobStatusV2Result	complete(List<MemberAddV2Result> value)	Returns an instance of MembersAddJobStatusV2Result that has its tag set to MembersAddJobStatusV2Result.Tag.COMPLETE.
boolean	equals(Object obj)
static MembersAddJobStatusV2Result	failed(String value)	Returns an instance of MembersAddJobStatusV2Result that has its tag set to MembersAddJobStatusV2Result.Tag.FAILED.
List<MemberAddV2Result>	getCompleteValue()	The asynchronous job has finished.
String	getFailedValue()	The asynchronous job returned an error.
int	hashCode()
boolean	isComplete()	Returns true if this instance has the tag MembersAddJobStatusV2Result.Tag.COMPLETE, false otherwise.
boolean	isFailed()	Returns true if this instance has the tag MembersAddJobStatusV2Result.Tag.FAILED, false otherwise.
boolean	isInProgress()	Returns true if this instance has the tag MembersAddJobStatusV2Result.Tag.IN_PROGRESS, false otherwise.
boolean	isOther()	Returns true if this instance has the tag MembersAddJobStatusV2Result.Tag.OTHER, false otherwise.
MembersAddJobStatusV2Result.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

IN_PROGRESS

public static final MembersAddJobStatusV2Result IN_PROGRESS

The asynchronous job is still in progress.

OTHER

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

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

Returns:

the tag for this instance.

isInProgress

public boolean isInProgress()

Returns true if this instance has the tag MembersAddJobStatusV2Result.Tag.IN_PROGRESS, false otherwise.

Returns:

true if this instance is tagged as MembersAddJobStatusV2Result.Tag.IN_PROGRESS, false otherwise.

isComplete

public boolean isComplete()

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

Returns:

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

complete

public static MembersAddJobStatusV2Result complete(List<MemberAddV2Result> value)

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

The asynchronous job has finished. For each member that was specified in the parameter MembersAddArg that was provided to DbxTeamTeamRequests.membersAddV2(List,boolean), a corresponding item is returned in this list.

Parameters:

value - value to assign to this instance.

Returns:

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

Throws:

IllegalArgumentException - if value contains a null item or is null.

getCompleteValue

public List<MemberAddV2Result> getCompleteValue()

The asynchronous job has finished. For each member that was specified in the parameter MembersAddArg that was provided to DbxTeamTeamRequests.membersAddV2(List,boolean), a corresponding item is returned in this list.

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

Returns:

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

Throws:

IllegalStateException - If isComplete() is false.

isFailed

public boolean isFailed()

Returns true if this instance has the tag MembersAddJobStatusV2Result.Tag.FAILED, false otherwise.

Returns:

true if this instance is tagged as MembersAddJobStatusV2Result.Tag.FAILED, false otherwise.

failed

public static MembersAddJobStatusV2Result failed(String value)

Returns an instance of MembersAddJobStatusV2Result that has its tag set to MembersAddJobStatusV2Result.Tag.FAILED.

The asynchronous job returned an error. The string contains an error message.

Parameters:

value - value to assign to this instance.

Returns:

Instance of MembersAddJobStatusV2Result with its tag set to MembersAddJobStatusV2Result.Tag.FAILED.

Throws:

IllegalArgumentException - if value is null.

getFailedValue

public String getFailedValue()

The asynchronous job returned an error. The string contains an error message.

This instance must be tagged as MembersAddJobStatusV2Result.Tag.FAILED.

Returns:

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

Throws:

IllegalStateException - If isFailed() is false.

isOther

public boolean isOther()

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

Returns:

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