Class SetTaskStatusRequest

    • Constructor Detail

      • SetTaskStatusRequest

        public SetTaskStatusRequest()
    • Method Detail

      • setTaskId

        public void setTaskId​(String taskId)

        The ID of the task assigned to the task runner. This value is provided in the response for PollForTask.

        Parameters:
        taskId - The ID of the task assigned to the task runner. This value is provided in the response for PollForTask.
      • getTaskId

        public String getTaskId()

        The ID of the task assigned to the task runner. This value is provided in the response for PollForTask.

        Returns:
        The ID of the task assigned to the task runner. This value is provided in the response for PollForTask.
      • withTaskId

        public SetTaskStatusRequest withTaskId​(String taskId)

        The ID of the task assigned to the task runner. This value is provided in the response for PollForTask.

        Parameters:
        taskId - The ID of the task assigned to the task runner. This value is provided in the response for PollForTask.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • setTaskStatus

        public void setTaskStatus​(String taskStatus)

        If FINISHED, the task successfully completed. If FAILED, the task ended unsuccessfully. Preconditions use false.

        Parameters:
        taskStatus - If FINISHED, the task successfully completed. If FAILED, the task ended unsuccessfully. Preconditions use false.
        See Also:
        TaskStatus
      • getTaskStatus

        public String getTaskStatus()

        If FINISHED, the task successfully completed. If FAILED, the task ended unsuccessfully. Preconditions use false.

        Returns:
        If FINISHED, the task successfully completed. If FAILED, the task ended unsuccessfully. Preconditions use false.
        See Also:
        TaskStatus
      • withTaskStatus

        public SetTaskStatusRequest withTaskStatus​(String taskStatus)

        If FINISHED, the task successfully completed. If FAILED, the task ended unsuccessfully. Preconditions use false.

        Parameters:
        taskStatus - If FINISHED, the task successfully completed. If FAILED, the task ended unsuccessfully. Preconditions use false.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        TaskStatus
      • setTaskStatus

        public void setTaskStatus​(TaskStatus taskStatus)

        If FINISHED, the task successfully completed. If FAILED, the task ended unsuccessfully. Preconditions use false.

        Parameters:
        taskStatus - If FINISHED, the task successfully completed. If FAILED, the task ended unsuccessfully. Preconditions use false.
        See Also:
        TaskStatus
      • withTaskStatus

        public SetTaskStatusRequest withTaskStatus​(TaskStatus taskStatus)

        If FINISHED, the task successfully completed. If FAILED, the task ended unsuccessfully. Preconditions use false.

        Parameters:
        taskStatus - If FINISHED, the task successfully completed. If FAILED, the task ended unsuccessfully. Preconditions use false.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        TaskStatus
      • setErrorId

        public void setErrorId​(String errorId)

        If an error occurred during the task, this value specifies the error code. This value is set on the physical attempt object. It is used to display error information to the user. It should not start with string "Service_" which is reserved by the system.

        Parameters:
        errorId - If an error occurred during the task, this value specifies the error code. This value is set on the physical attempt object. It is used to display error information to the user. It should not start with string "Service_" which is reserved by the system.
      • getErrorId

        public String getErrorId()

        If an error occurred during the task, this value specifies the error code. This value is set on the physical attempt object. It is used to display error information to the user. It should not start with string "Service_" which is reserved by the system.

        Returns:
        If an error occurred during the task, this value specifies the error code. This value is set on the physical attempt object. It is used to display error information to the user. It should not start with string "Service_" which is reserved by the system.
      • withErrorId

        public SetTaskStatusRequest withErrorId​(String errorId)

        If an error occurred during the task, this value specifies the error code. This value is set on the physical attempt object. It is used to display error information to the user. It should not start with string "Service_" which is reserved by the system.

        Parameters:
        errorId - If an error occurred during the task, this value specifies the error code. This value is set on the physical attempt object. It is used to display error information to the user. It should not start with string "Service_" which is reserved by the system.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • setErrorMessage

        public void setErrorMessage​(String errorMessage)

        If an error occurred during the task, this value specifies a text description of the error. This value is set on the physical attempt object. It is used to display error information to the user. The web service does not parse this value.

        Parameters:
        errorMessage - If an error occurred during the task, this value specifies a text description of the error. This value is set on the physical attempt object. It is used to display error information to the user. The web service does not parse this value.
      • getErrorMessage

        public String getErrorMessage()

        If an error occurred during the task, this value specifies a text description of the error. This value is set on the physical attempt object. It is used to display error information to the user. The web service does not parse this value.

        Returns:
        If an error occurred during the task, this value specifies a text description of the error. This value is set on the physical attempt object. It is used to display error information to the user. The web service does not parse this value.
      • withErrorMessage

        public SetTaskStatusRequest withErrorMessage​(String errorMessage)

        If an error occurred during the task, this value specifies a text description of the error. This value is set on the physical attempt object. It is used to display error information to the user. The web service does not parse this value.

        Parameters:
        errorMessage - If an error occurred during the task, this value specifies a text description of the error. This value is set on the physical attempt object. It is used to display error information to the user. The web service does not parse this value.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • setErrorStackTrace

        public void setErrorStackTrace​(String errorStackTrace)

        If an error occurred during the task, this value specifies the stack trace associated with the error. This value is set on the physical attempt object. It is used to display error information to the user. The web service does not parse this value.

        Parameters:
        errorStackTrace - If an error occurred during the task, this value specifies the stack trace associated with the error. This value is set on the physical attempt object. It is used to display error information to the user. The web service does not parse this value.
      • getErrorStackTrace

        public String getErrorStackTrace()

        If an error occurred during the task, this value specifies the stack trace associated with the error. This value is set on the physical attempt object. It is used to display error information to the user. The web service does not parse this value.

        Returns:
        If an error occurred during the task, this value specifies the stack trace associated with the error. This value is set on the physical attempt object. It is used to display error information to the user. The web service does not parse this value.
      • withErrorStackTrace

        public SetTaskStatusRequest withErrorStackTrace​(String errorStackTrace)

        If an error occurred during the task, this value specifies the stack trace associated with the error. This value is set on the physical attempt object. It is used to display error information to the user. The web service does not parse this value.

        Parameters:
        errorStackTrace - If an error occurred during the task, this value specifies the stack trace associated with the error. This value is set on the physical attempt object. It is used to display error information to the user. The web service does not parse this value.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • toString

        public String toString()
        Returns a string representation of this object; useful for testing and debugging.
        Overrides:
        toString in class Object
        Returns:
        A string representation of this object.
        See Also:
        Object.toString()
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object