SetTaskStatusRequest (AWS SDK for Java

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

All Implemented Interfaces:

Serializable
```
public class SetTaskStatusRequest
extends AmazonWebServiceRequest
implements 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.

See Also:
DataPipeline.setTaskStatus(SetTaskStatusRequest), Serialized Form

Constructor Summary

Constructors
Constructor and Description

SetTaskStatusRequest()

Constructors
Constructor and Description
`SetTaskStatusRequest()`

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`String`	`getErrorId()` If an error occurred during the task, this value specifies an id value that represents the error.
`String`	`getErrorMessage()` If an error occurred during the task, this value specifies a text description of the error.
`String`	`getErrorStackTrace()` If an error occurred during the task, this value specifies the stack trace associated with the error.
`String`	`getTaskId()` Identifies the task assigned to the task runner.
`String`	`getTaskStatus()` If `FINISHED`, the task successfully completed.
`int`	`hashCode()`
`void`	`setErrorId(String errorId)` If an error occurred during the task, this value specifies an id value that represents the error.
`void`	`setErrorMessage(String errorMessage)` If an error occurred during the task, this value specifies a text description of the error.
`void`	`setErrorStackTrace(String errorStackTrace)` If an error occurred during the task, this value specifies the stack trace associated with the error.
`void`	`setTaskId(String taskId)` Identifies the task assigned to the task runner.
`void`	`setTaskStatus(String taskStatus)` If `FINISHED`, the task successfully completed.
`void`	`setTaskStatus(TaskStatus taskStatus)` If `FINISHED`, the task successfully completed.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`SetTaskStatusRequest`	`withErrorId(String errorId)` If an error occurred during the task, this value specifies an id value that represents the error.
`SetTaskStatusRequest`	`withErrorMessage(String errorMessage)` If an error occurred during the task, this value specifies a text description of the error.
`SetTaskStatusRequest`	`withErrorStackTrace(String errorStackTrace)` If an error occurred during the task, this value specifies the stack trace associated with the error.
`SetTaskStatusRequest`	`withTaskId(String taskId)` Identifies the task assigned to the task runner.
`SetTaskStatusRequest`	`withTaskStatus(String taskStatus)` If `FINISHED`, the task successfully completed.
`SetTaskStatusRequest`	`withTaskStatus(TaskStatus taskStatus)` If `FINISHED`, the task successfully completed.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setRequestCredentials, setRequestMetricCollector, withRequestMetricCollector

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - SetTaskStatusRequest
```
public SetTaskStatusRequest()
```
- Method Detail
  - getTaskId
```
public 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]*
    
    Returns:
    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(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]*
    
    Parameters:
    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(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]*
    
    Parameters:
    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 updated object so that method calls can be chained together.
  - getTaskStatus
```
public 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
    
    Returns:
    If FINISHED, the task successfully completed. If FAILED the task ended unsuccessfully. The FALSE value is used by preconditions.
    See Also:
    TaskStatus
  - setTaskStatus
```
public void setTaskStatus(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
    
    Parameters:
    taskStatus - If FINISHED, the task successfully completed. If FAILED the task ended unsuccessfully. The FALSE value is used by preconditions.
    See Also:
    TaskStatus
  - withTaskStatus
```
public SetTaskStatusRequest withTaskStatus(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
    
    Parameters:
    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 updated 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. The FALSE value is used by preconditions.
    Constraints:
    Allowed Values: FINISHED, FAILED, FALSE
    
    Parameters:
    taskStatus - If FINISHED, the task successfully completed. If FAILED the task ended unsuccessfully. The FALSE value is used by preconditions.
    See Also:
    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
    
    Parameters:
    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 updated object so that method calls can be chained together.
    See Also:
    TaskStatus
  - getErrorId
```
public 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]*
    
    Returns:
    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(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]*
    
    Parameters:
    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(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]*
    
    Parameters:
    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 updated object so that method calls can be chained together.
  - 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.
  - 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.
  - 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.
    Returns a reference to this object so that method calls can be chained together.
    
    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:
    A reference to this updated object so that method calls can be chained together.
  - 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.
    Constraints:
    Length: 0 - 1024
    Pattern: [ -퟿-�𐀀-􏿿\r\n\t]*
    
    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.
  - 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.
    Constraints:
    Length: 0 - 1024
    Pattern: [ -퟿-�𐀀-􏿿\r\n\t]*
    
    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.
  - 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.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 0 - 1024
    Pattern: [ -퟿-�𐀀-􏿿\r\n\t]*
    
    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:
    A reference to this updated 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
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object

Did this page help you?

Class SetTaskStatusRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

SetTaskStatusRequest

Method Detail

getTaskId

setTaskId

withTaskId

getTaskStatus

setTaskStatus

withTaskStatus

setTaskStatus

withTaskStatus

getErrorId

setErrorId

withErrorId

getErrorMessage

setErrorMessage

withErrorMessage

getErrorStackTrace

setErrorStackTrace

withErrorStackTrace

toString

hashCode

equals