Package com.dropbox.core.v2.async

Class LaunchResultBase

java.lang.Object
com.dropbox.core.v2.async.LaunchResultBase
public final class LaunchResultBase extends Object
Result returned by methods that launch an asynchronous job. A method who may either launch an asynchronous job, or complete the request synchronously, can use this union by extending it, and adding a 'complete' field with the type of the synchronous response. See LaunchEmptyResult for an example.

This class is a 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.

  • Method Details

    • tag

      public LaunchResultBase.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 LaunchResultBase.

      Returns:
      the tag for this instance.

    • isAsyncJobId

      public boolean isAsyncJobId()
      Returns true if this instance has the tag LaunchResultBase.Tag.ASYNC_JOB_ID, false otherwise.
      Returns:
      true if this instance is tagged as LaunchResultBase.Tag.ASYNC_JOB_ID, false otherwise.

    • asyncJobId

      public static LaunchResultBase asyncJobId(String value)
      Returns an instance of LaunchResultBase that has its tag set to LaunchResultBase.Tag.ASYNC_JOB_ID.

      This response indicates that the processing is asynchronous. The string is an id that can be used to obtain the status of the asynchronous job.

      Parameters:
      value - value to assign to this instance.
      Returns:
      Instance of LaunchResultBase with its tag set to LaunchResultBase.Tag.ASYNC_JOB_ID.
      Throws:
      IllegalArgumentException - if value is shorter than 1 or is null.

    • getAsyncJobIdValue

      public String getAsyncJobIdValue()
      This response indicates that the processing is asynchronous. The string is an id that can be used to obtain the status of the asynchronous job.

      This instance must be tagged as LaunchResultBase.Tag.ASYNC_JOB_ID.

      Returns:
      The String value associated with this instance if isAsyncJobId() is true.
      Throws:
      IllegalStateException - If isAsyncJobId() is false.

    • 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