Package com.dropbox.core.v2.files

Class SaveUrlResult

java.lang.Object
com.dropbox.core.v2.files.SaveUrlResult
public final class SaveUrlResult extends Object
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 SaveUrlResult.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 SaveUrlResult.

      Returns:
      the tag for this instance.

    • isAsyncJobId

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

    • asyncJobId

      public static SaveUrlResult asyncJobId(String value)
      Returns an instance of SaveUrlResult that has its tag set to SaveUrlResult.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 SaveUrlResult with its tag set to SaveUrlResult.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 SaveUrlResult.Tag.ASYNC_JOB_ID.

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

    • isComplete

      public boolean isComplete()
      Returns true if this instance has the tag SaveUrlResult.Tag.COMPLETE, false otherwise.
      Returns:
      true if this instance is tagged as SaveUrlResult.Tag.COMPLETE, false otherwise.

    • complete

      public static SaveUrlResult complete(FileMetadata value)
      Returns an instance of SaveUrlResult that has its tag set to SaveUrlResult.Tag.COMPLETE.

      Metadata of the file where the URL is saved to.

      Parameters:
      value - value to assign to this instance.
      Returns:
      Instance of SaveUrlResult with its tag set to SaveUrlResult.Tag.COMPLETE.
      Throws:
      IllegalArgumentException - if value is null.

    • getCompleteValue

      public FileMetadata getCompleteValue()
      Metadata of the file where the URL is saved to.

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

      Returns:
      The FileMetadata value associated with this instance if isComplete() is true.
      Throws:
      IllegalStateException - If isComplete() 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