com.amazonaws.services.datapipeline.model

## クラス SetTaskStatusRequest

- java.lang.Object
- - com.amazonaws.AmazonWebServiceRequest
  - - com.amazonaws.services.datapipeline.model.SetTaskStatusRequest

- すべての実装されたインタフェース:
    java.io.Serializable

      public class SetTaskStatusRequest
      extends AmazonWebServiceRequest
      implements java.io.Serializable

  Container for the parameters to the `SetTaskStatus operation`.

  Notifies AWS Data Pipeline that a task is completed and provides information about the final status. The task runner calls this action regardless of whether the task was sucessful. The task runner does not need to call SetTaskStatus for tasks that are canceled by the web service during a call to ReportTaskProgress.

  関連項目:
    `DataPipeline.setTaskStatus(SetTaskStatusRequest)`, 直列化された形式

- - ### コンストラクタの概要

    コンストラクタ
    コンストラクタと説明
    `SetTaskStatusRequest()`

  - ### メソッドの概要

    メソッド
    修飾子とタイプ | メソッドと説明
    --- | ---
    `boolean` | `equals(java.lang.Object obj)`
    `java.lang.String` | `getErrorId()` If an error occurred during the task, this value specifies an id value that represents the error.
    `java.lang.String` | `getErrorMessage()` If an error occurred during the task, this value specifies a text description of the error.
    `java.lang.String` | `getErrorStackTrace()` If an error occurred during the task, this value specifies the stack trace associated with the error.
    `java.lang.String` | `getTaskId()` Identifies the task assigned to the task runner.
    `java.lang.String` | `getTaskStatus()` If `FINISHED`, the task successfully completed.
    `int` | `hashCode()`
    `void` | `setErrorId(java.lang.String errorId)` If an error occurred during the task, this value specifies an id value that represents the error.
    `void` | `setErrorMessage(java.lang.String errorMessage)` If an error occurred during the task, this value specifies a text description of the error.
    `void` | `setErrorStackTrace(java.lang.String errorStackTrace)` If an error occurred during the task, this value specifies the stack trace associated with the error.
    `void` | `setTaskId(java.lang.String taskId)` Identifies the task assigned to the task runner.
    `void` | `setTaskStatus(java.lang.String taskStatus)` If `FINISHED`, the task successfully completed.
    `void` | `setTaskStatus(TaskStatus taskStatus)` If `FINISHED`, the task successfully completed.
    `java.lang.String` | `toString()` Returns a string representation of this object; useful for testing and debugging.
    `SetTaskStatusRequest` | `withErrorId(java.lang.String errorId)` If an error occurred during the task, this value specifies an id value that represents the error.
    `SetTaskStatusRequest` | `withErrorMessage(java.lang.String errorMessage)` If an error occurred during the task, this value specifies a text description of the error.
    `SetTaskStatusRequest` | `withErrorStackTrace(java.lang.String errorStackTrace)` If an error occurred during the task, this value specifies the stack trace associated with the error.
    `SetTaskStatusRequest` | `withTaskId(java.lang.String taskId)` Identifies the task assigned to the task runner.
    `SetTaskStatusRequest` | `withTaskStatus(java.lang.String taskStatus)` If `FINISHED`, the task successfully completed.
    `SetTaskStatusRequest` | `withTaskStatus(TaskStatus taskStatus)` If `FINISHED`, the task successfully completed.

    - ### クラスから継承されたメソッド com.amazonaws.AmazonWebServiceRequest

      `copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, setRequestCredentials`

    - ### クラスから継承されたメソッド java.lang.Object

      `clone, finalize, getClass, notify, notifyAll, wait, wait, wait`

- - ### コンストラクタの詳細

    - #### SetTaskStatusRequest

          public SetTaskStatusRequest()

  - ### メソッドの詳細

    - #### getTaskId

          public java.lang.String getTaskId()

      Identifies the task assigned to the task runner. This value is set in the TaskObject that is returned by the PollForTask action.

      Constraints:
      Length: 1 - 2048
      Pattern: [ -퟿-�𐀀-􏿿\r\n\t]*

      戻り値:
        Identifies the task assigned to the task runner. This value is set in the TaskObject that is returned by the PollForTask action.

    - #### setTaskId

          public void setTaskId(java.lang.String taskId)

      Identifies the task assigned to the task runner. This value is set in the TaskObject that is returned by the PollForTask action.

      Constraints:
      Length: 1 - 2048
      Pattern: [ -퟿-�𐀀-􏿿\r\n\t]*

      パラメータ:
        `taskId` - Identifies the task assigned to the task runner. This value is set in the TaskObject that is returned by the PollForTask action.

    - #### withTaskId

          public SetTaskStatusRequest withTaskId(java.lang.String taskId)

      Identifies the task assigned to the task runner. This value is set in the TaskObject that is returned by the PollForTask action.

      Returns a reference to this object so that method calls can be chained together.

      Constraints:
      Length: 1 - 2048
      Pattern: [ -퟿-�𐀀-􏿿\r\n\t]*

      パラメータ:
        `taskId` - Identifies the task assigned to the task runner. This value is set in the TaskObject that is returned by the PollForTask action.

    - #### getTaskStatus

          public java.lang.String getTaskStatus()

      If `FINISHED`, the task successfully completed. If `FAILED` the task ended unsuccessfully. The `FALSE` value is used by preconditions.

      Constraints:
      Allowed Values: FINISHED, FAILED, FALSE

      戻り値:
        If `FINISHED`, the task successfully completed. If `FAILED` the task ended unsuccessfully. The `FALSE` value is used by preconditions.
      関連項目:
        `TaskStatus`

    - #### setTaskStatus

          public void setTaskStatus(java.lang.String taskStatus)

      If `FINISHED`, the task successfully completed. If `FAILED` the task ended unsuccessfully. The `FALSE` value is used by preconditions.

      Constraints:
      Allowed Values: FINISHED, FAILED, FALSE

      パラメータ:
        `taskStatus` - If `FINISHED`, the task successfully completed. If `FAILED` the task ended unsuccessfully. The `FALSE` value is used by preconditions.
      関連項目:
        `TaskStatus`

    - #### withTaskStatus

          public SetTaskStatusRequest withTaskStatus(java.lang.String taskStatus)

      If `FINISHED`, the task successfully completed. If `FAILED` the task ended unsuccessfully. The `FALSE` value is used by preconditions.

      Returns a reference to this object so that method calls can be chained together.

      Constraints:
      Allowed Values: FINISHED, FAILED, FALSE

      パラメータ:
        `taskStatus` - If `FINISHED`, the task successfully completed. If `FAILED` the task ended unsuccessfully. The `FALSE` value is used by preconditions.
      関連項目:
        `TaskStatus`

    - #### setTaskStatus

          public void setTaskStatus(TaskStatus taskStatus)

      If `FINISHED`, the task successfully completed. If `FAILED` the task ended unsuccessfully. The `FALSE` value is used by preconditions.

      Constraints:
      Allowed Values: FINISHED, FAILED, FALSE

      パラメータ:
        `taskStatus` - If `FINISHED`, the task successfully completed. If `FAILED` the task ended unsuccessfully. The `FALSE` value is used by preconditions.
      関連項目:
        `TaskStatus`

    - #### withTaskStatus

          public SetTaskStatusRequest withTaskStatus(TaskStatus taskStatus)

      If `FINISHED`, the task successfully completed. If `FAILED` the task ended unsuccessfully. The `FALSE` value is used by preconditions.

      Returns a reference to this object so that method calls can be chained together.

      Constraints:
      Allowed Values: FINISHED, FAILED, FALSE

      パラメータ:
        `taskStatus` - If `FINISHED`, the task successfully completed. If `FAILED` the task ended unsuccessfully. The `FALSE` value is used by preconditions.
      関連項目:
        `TaskStatus`

    - #### getErrorId

          public java.lang.String getErrorId()

      If an error occurred during the task, this value specifies an id value that represents the error. 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.

      Constraints:
      Length: 0 - 1024
      Pattern: [ -퟿-�𐀀-􏿿\r\n\t]*

      戻り値:
        If an error occurred during the task, this value specifies an id value that represents the error. 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.

    - #### setErrorId

          public void setErrorId(java.lang.String errorId)

      If an error occurred during the task, this value specifies an id value that represents the error. 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.

      Constraints:
      Length: 0 - 1024
      Pattern: [ -퟿-�𐀀-􏿿\r\n\t]*

      パラメータ:
        `errorId` - If an error occurred during the task, this value specifies an id value that represents the error. 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(java.lang.String errorId)

      If an error occurred during the task, this value specifies an id value that represents the error. 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 a reference to this object so that method calls can be chained together.

      Constraints:
      Length: 0 - 1024
      Pattern: [ -퟿-�𐀀-􏿿\r\n\t]*

      パラメータ:
        `errorId` - If an error occurred during the task, this value specifies an id value that represents the error. 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.

    - #### getErrorMessage

          public java.lang.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.
      戻り値:
        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.

    - #### setErrorMessage

          public void setErrorMessage(java.lang.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.
      パラメータ:
        `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.

    - #### withErrorMessage

          public SetTaskStatusRequest withErrorMessage(java.lang.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.

      Returns a reference to this object so that method calls can be chained together.

      パラメータ:
        `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.

    - #### getErrorStackTrace

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

      Constraints:
      Length: 0 - 1024
      Pattern: [ -퟿-�𐀀-􏿿\r\n\t]*

      戻り値:
        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.

    - #### setErrorStackTrace

          public void setErrorStackTrace(java.lang.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.

      Constraints:
      Length: 0 - 1024
      Pattern: [ -퟿-�𐀀-􏿿\r\n\t]*

      パラメータ:
        `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.

    - #### withErrorStackTrace

          public SetTaskStatusRequest withErrorStackTrace(java.lang.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.

      Returns a reference to this object so that method calls can be chained together.

      Constraints:
      Length: 0 - 1024
      Pattern: [ -퟿-�𐀀-􏿿\r\n\t]*

      パラメータ:
        `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.

    - #### toString

          public java.lang.String toString()

      Returns a string representation of this object; useful for testing and debugging.
      オーバーライド:
        `toString` クラス内 `java.lang.Object`
      戻り値:
        A string representation of this object.
      関連項目:
        `Object.toString()`

    - #### hashCode

          public int hashCode()

      オーバーライド:
        `hashCode` クラス内 `java.lang.Object`

    - #### equals

          public boolean equals(java.lang.Object obj)

      オーバーライド:
        `equals` クラス内 `java.lang.Object`