Class MembersAddJobStatusV2Result
- java.lang.Object
-
- com.dropbox.core.v2.team.MembersAddJobStatusV2Result
-
public final class MembersAddJobStatusV2Result extends java.lang.ObjectThis 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
OTHERvalue will be used.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classMembersAddJobStatusV2Result.TagDiscriminating tag type forMembersAddJobStatusV2Result.
-
Field Summary
Fields Modifier and Type Field Description static MembersAddJobStatusV2ResultIN_PROGRESSThe asynchronous job is still in progress.static MembersAddJobStatusV2ResultOTHERCatch-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 MembersAddJobStatusV2Resultcomplete(java.util.List<MemberAddV2Result> value)Returns an instance ofMembersAddJobStatusV2Resultthat has its tag set toMembersAddJobStatusV2Result.Tag.COMPLETE.booleanequals(java.lang.Object obj)static MembersAddJobStatusV2Resultfailed(java.lang.String value)Returns an instance ofMembersAddJobStatusV2Resultthat has its tag set toMembersAddJobStatusV2Result.Tag.FAILED.java.util.List<MemberAddV2Result>getCompleteValue()The asynchronous job has finished.java.lang.StringgetFailedValue()The asynchronous job returned an error.inthashCode()booleanisComplete()Returnstrueif this instance has the tagMembersAddJobStatusV2Result.Tag.COMPLETE,falseotherwise.booleanisFailed()booleanisInProgress()Returnstrueif this instance has the tagMembersAddJobStatusV2Result.Tag.IN_PROGRESS,falseotherwise.booleanisOther()MembersAddJobStatusV2Result.Tagtag()Returns the tag for this instance.java.lang.StringtoString()java.lang.StringtoStringMultiline()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 aswitchstatement to properly handle the different values for thisMembersAddJobStatusV2Result.If a tag returned by the server is unrecognized by this SDK, the
MembersAddJobStatusV2Result.Tag.OTHERvalue will be used.- Returns:
- the tag for this instance.
-
isInProgress
public boolean isInProgress()
Returnstrueif this instance has the tagMembersAddJobStatusV2Result.Tag.IN_PROGRESS,falseotherwise.- Returns:
trueif this instance is tagged asMembersAddJobStatusV2Result.Tag.IN_PROGRESS,falseotherwise.
-
isComplete
public boolean isComplete()
Returnstrueif this instance has the tagMembersAddJobStatusV2Result.Tag.COMPLETE,falseotherwise.- Returns:
trueif this instance is tagged asMembersAddJobStatusV2Result.Tag.COMPLETE,falseotherwise.
-
complete
public static MembersAddJobStatusV2Result complete(java.util.List<MemberAddV2Result> value)
Returns an instance ofMembersAddJobStatusV2Resultthat has its tag set toMembersAddJobStatusV2Result.Tag.COMPLETE.The asynchronous job has finished. For each member that was specified in the parameter
MembersAddArgthat 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
MembersAddJobStatusV2Resultwith its tag set toMembersAddJobStatusV2Result.Tag.COMPLETE. - Throws:
java.lang.IllegalArgumentException- ifvaluecontains anullitem or isnull.
-
getCompleteValue
public java.util.List<MemberAddV2Result> getCompleteValue()
The asynchronous job has finished. For each member that was specified in the parameterMembersAddArgthat 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
Listvalue associated with this instance ifisComplete()istrue. - Throws:
java.lang.IllegalStateException- IfisComplete()isfalse.
-
isFailed
public boolean isFailed()
- Returns:
trueif this instance is tagged asMembersAddJobStatusV2Result.Tag.FAILED,falseotherwise.
-
failed
public static MembersAddJobStatusV2Result failed(java.lang.String value)
Returns an instance ofMembersAddJobStatusV2Resultthat 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
MembersAddJobStatusV2Resultwith its tag set toMembersAddJobStatusV2Result.Tag.FAILED. - Throws:
java.lang.IllegalArgumentException- ifvalueisnull.
-
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
Stringvalue associated with this instance ifisFailed()istrue. - Throws:
java.lang.IllegalStateException- IfisFailed()isfalse.
-
isOther
public boolean isOther()
- Returns:
trueif this instance is tagged asMembersAddJobStatusV2Result.Tag.OTHER,falseotherwise.
-
hashCode
public int hashCode()
- Overrides:
hashCodein classjava.lang.Object
-
equals
public boolean equals(java.lang.Object obj)
- Overrides:
equalsin classjava.lang.Object
-
toString
public java.lang.String toString()
- Overrides:
toStringin 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
-
-