Package com.dropbox.core.v2.riviera

Class GetTranscriptAsyncCheckResult

java.lang.Object

com.dropbox.core.v2.riviera.GetTranscriptAsyncCheckResult

public final class GetTranscriptAsyncCheckResult
extends Object

Result type for EventBus async check - must end in "CheckResult"

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	GetTranscriptAsyncCheckResult.Tag	Discriminating tag type for GetTranscriptAsyncCheckResult.

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
static GetTranscriptAsyncCheckResult	complete(GetTranscriptResult value)	Returns an instance of GetTranscriptAsyncCheckResult that has its tag set to GetTranscriptAsyncCheckResult.Tag.COMPLETE.
boolean	equals(Object obj)
static GetTranscriptAsyncCheckResult	failed(GetTranscriptAsyncError value)	Returns an instance of GetTranscriptAsyncCheckResult that has its tag set to GetTranscriptAsyncCheckResult.Tag.FAILED.
GetTranscriptResult	getCompleteValue()	This instance must be tagged as GetTranscriptAsyncCheckResult.Tag.COMPLETE.
GetTranscriptAsyncError	getFailedValue()	This instance must be tagged as GetTranscriptAsyncCheckResult.Tag.FAILED.
int	hashCode()
boolean	isComplete()	Returns true if this instance has the tag GetTranscriptAsyncCheckResult.Tag.COMPLETE, false otherwise.
boolean	isFailed()	Returns true if this instance has the tag GetTranscriptAsyncCheckResult.Tag.FAILED, false otherwise.
boolean	isInProgress()	Returns true if this instance has the tag GetTranscriptAsyncCheckResult.Tag.IN_PROGRESS, false otherwise.
boolean	isOther()	Returns true if this instance has the tag GetTranscriptAsyncCheckResult.Tag.OTHER, false otherwise.
GetTranscriptAsyncCheckResult.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 GetTranscriptAsyncCheckResult IN_PROGRESS

OTHER

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

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

Returns:

the tag for this instance.

isInProgress

public boolean isInProgress()

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

Returns:

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

isComplete

public boolean isComplete()

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

Returns:

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

complete

public static GetTranscriptAsyncCheckResult complete(GetTranscriptResult value)

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

None

Parameters:

value - value to assign to this instance.

Returns:

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

Throws:

IllegalArgumentException - if value is null.

getCompleteValue

public GetTranscriptResult getCompleteValue()

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

Returns:

The GetTranscriptResult 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 GetTranscriptAsyncCheckResult.Tag.FAILED, false otherwise.

Returns:

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

failed

public static GetTranscriptAsyncCheckResult failed(GetTranscriptAsyncError value)

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

None

Parameters:

value - value to assign to this instance.

Returns:

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

Throws:

IllegalArgumentException - if value is null.

getFailedValue

public GetTranscriptAsyncError getFailedValue()

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

Returns:

The GetTranscriptAsyncError 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 GetTranscriptAsyncCheckResult.Tag.OTHER, false otherwise.

Returns:

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