Class MembersAddJobStatusV2Result
- java.lang.Object
-
- com.dropbox.core.v2.team.MembersAddJobStatusV2Result
-
public final class MembersAddJobStatusV2Result extends java.lang.Object
This class is an open tagged union. Tagged unions instances are always associated to a specific tag. This means only one of theisAbc()
methods will returntrue
. You can usetag()
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 class
MembersAddJobStatusV2Result.Tag
Discriminating tag type forMembersAddJobStatusV2Result
.
-
Field Summary
Fields Modifier and Type Field Description static MembersAddJobStatusV2Result
IN_PROGRESS
The asynchronous job is still in progress.static MembersAddJobStatusV2Result
OTHER
Catch-all used for unknown tag values returned by the Dropbox servers.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static MembersAddJobStatusV2Result
complete(java.util.List<MemberAddV2Result> value)
Returns an instance ofMembersAddJobStatusV2Result
that has its tag set toMembersAddJobStatusV2Result.Tag.COMPLETE
.boolean
equals(java.lang.Object obj)
static MembersAddJobStatusV2Result
failed(java.lang.String value)
Returns an instance ofMembersAddJobStatusV2Result
that has its tag set toMembersAddJobStatusV2Result.Tag.FAILED
.java.util.List<MemberAddV2Result>
getCompleteValue()
The asynchronous job has finished.java.lang.String
getFailedValue()
The asynchronous job returned an error.int
hashCode()
boolean
isComplete()
Returnstrue
if this instance has the tagMembersAddJobStatusV2Result.Tag.COMPLETE
,false
otherwise.boolean
isFailed()
boolean
isInProgress()
Returnstrue
if this instance has the tagMembersAddJobStatusV2Result.Tag.IN_PROGRESS
,false
otherwise.boolean
isOther()
MembersAddJobStatusV2Result.Tag
tag()
Returns the tag for this instance.java.lang.String
toString()
java.lang.String
toStringMultiline()
Returns a String representation of this object formatted for easier readability.
-
-
-
Field Detail
-
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 Detail
-
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 returntrue
. Callers are recommended to use the tag value in aswitch
statement to properly handle the different values for thisMembersAddJobStatusV2Result
.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()
Returnstrue
if this instance has the tagMembersAddJobStatusV2Result.Tag.IN_PROGRESS
,false
otherwise.- Returns:
true
if this instance is tagged asMembersAddJobStatusV2Result.Tag.IN_PROGRESS
,false
otherwise.
-
isComplete
public boolean isComplete()
Returnstrue
if this instance has the tagMembersAddJobStatusV2Result.Tag.COMPLETE
,false
otherwise.- Returns:
true
if this instance is tagged asMembersAddJobStatusV2Result.Tag.COMPLETE
,false
otherwise.
-
complete
public static MembersAddJobStatusV2Result complete(java.util.List<MemberAddV2Result> value)
Returns an instance ofMembersAddJobStatusV2Result
that has its tag set toMembersAddJobStatusV2Result.Tag.COMPLETE
.The asynchronous job has finished. For each member that was specified in the parameter
MembersAddArg
that was provided toDbxTeamTeamRequests.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 toMembersAddJobStatusV2Result.Tag.COMPLETE
. - Throws:
java.lang.IllegalArgumentException
- ifvalue
contains anull
item or isnull
.
-
getCompleteValue
public java.util.List<MemberAddV2Result> getCompleteValue()
The asynchronous job has finished. For each member that was specified in the parameterMembersAddArg
that was provided toDbxTeamTeamRequests.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 ifisComplete()
istrue
. - Throws:
java.lang.IllegalStateException
- IfisComplete()
isfalse
.
-
isFailed
public boolean isFailed()
- Returns:
true
if this instance is tagged asMembersAddJobStatusV2Result.Tag.FAILED
,false
otherwise.
-
failed
public static MembersAddJobStatusV2Result failed(java.lang.String value)
Returns an instance ofMembersAddJobStatusV2Result
that has its tag set toMembersAddJobStatusV2Result.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 toMembersAddJobStatusV2Result.Tag.FAILED
. - Throws:
java.lang.IllegalArgumentException
- ifvalue
isnull
.
-
getFailedValue
public java.lang.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 ifisFailed()
istrue
. - Throws:
java.lang.IllegalStateException
- IfisFailed()
isfalse
.
-
isOther
public boolean isOther()
- Returns:
true
if this instance is tagged asMembersAddJobStatusV2Result.Tag.OTHER
,false
otherwise.
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
equals
public boolean equals(java.lang.Object obj)
- Overrides:
equals
in classjava.lang.Object
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
toStringMultiline
public java.lang.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
-
-