Class LaunchEmptyResult


  • public final class LaunchEmptyResult
    extends java.lang.Object
    Result returned by methods that may either launch an asynchronous job or complete synchronously. Upon synchronous completion of the job, no additional information is returned.

    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.

    • Field Detail

      • COMPLETE

        public static final LaunchEmptyResult COMPLETE
        The job finished synchronously and successfully.
    • Method Detail

      • tag

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

        Returns:
        the tag for this instance.
      • asyncJobId

        public static LaunchEmptyResult asyncJobId​(java.lang.String value)
        Returns an instance of LaunchEmptyResult that has its tag set to LaunchEmptyResult.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 LaunchEmptyResult with its tag set to LaunchEmptyResult.Tag.ASYNC_JOB_ID.
        Throws:
        java.lang.IllegalArgumentException - if value is shorter than 1 or is null.
      • getAsyncJobIdValue

        public java.lang.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 LaunchEmptyResult.Tag.ASYNC_JOB_ID.

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

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object
      • equals

        public boolean equals​(java.lang.Object obj)
        Overrides:
        equals in class java.lang.Object
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.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