com.amazonaws.services.datapipeline.model

Class SetTaskStatusRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.datapipeline.model.SetTaskStatusRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class SetTaskStatusRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the SetTaskStatus operation.

Task runners call SetTaskStatus to notify AWS Data Pipeline that a task is completed and provide information about the final status. A task runner makes this call regardless of whether the task was sucessful. A 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

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
SetTaskStatusRequest()

Method Summary

Methods

Modifier and Type	Method and Description
SetTaskStatusRequest	clone() Creates a shallow clone of this request.
boolean	equals(Object obj)
String	getErrorId() If an error occurred during the task, this value specifies the error code.
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() The ID of 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 the error code.
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) The ID of 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 the error code.
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) The ID of 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

copyBaseTo, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SetTaskStatusRequest

public SetTaskStatusRequest()

Method Detail

getTaskId

public String getTaskId()

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

Constraints:
Length: 1 - 2048
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Returns:

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

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.

Constraints:
Length: 1 - 2048
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Parameters:

taskId - 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.

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

Constraints:
Length: 1 - 2048
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Parameters:

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

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. Preconditions use false.

Constraints:
Allowed Values: FINISHED, FAILED, FALSE

Returns:

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

See Also:

TaskStatus

setTaskStatus

public void setTaskStatus(String taskStatus)

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

Constraints:
Allowed Values: FINISHED, FAILED, 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(String taskStatus)

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

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. Preconditions use false.

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. Preconditions use false.

Constraints:
Allowed Values: FINISHED, FAILED, 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.

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. Preconditions use false.

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

Constraints:
Length: 0 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

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.

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.

Constraints:
Length: 0 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

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.

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.

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

Constraints:
Length: 0 - 1024
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

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:

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: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\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: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\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: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\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

clone

public SetTaskStatusRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()