com.amazonaws.services.simpleworkflow.model

Class RespondActivityTaskFailedRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.simpleworkflow.model.RespondActivityTaskFailedRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class RespondActivityTaskFailedRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the RespondActivityTaskFailed operation.

Used by workers to tell the service that the ActivityTask identified by the taskToken has failed with reason (if specified). The reason and details appear in the ActivityTaskFailed event added to the workflow history.

A task is considered open from the time that it is scheduled until it is closed. Therefore a task is reported as open while a worker is processing it. A task is closed after it has been specified in a call to RespondActivityTaskCompleted, RespondActivityTaskCanceled, RespondActivityTaskFailed, or the task has timed out .

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

• Use a Resource element with the domain name to limit the action to only specified domains.
• Use an Action element to allow or deny permission to call this action.
• You cannot use an IAM policy to constrain this action's parameters.

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows .

See Also:

AmazonSimpleWorkflow.respondActivityTaskFailed(RespondActivityTaskFailedRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
RespondActivityTaskFailedRequest()

Method Summary

Methods

Modifier and Type	Method and Description
RespondActivityTaskFailedRequest	clone() Creates a shallow clone of this request.
boolean	equals(Object obj)
String	getDetails() Optional. Detailed information about the failure.
String	getReason() Description of the error that may assist in diagnostics.
String	getTaskToken() The taskToken of the ActivityTask.
int	hashCode()
void	setDetails(String details) Optional. Detailed information about the failure.
void	setReason(String reason) Description of the error that may assist in diagnostics.
void	setTaskToken(String taskToken) The taskToken of the ActivityTask.
String	toString() Returns a string representation of this object; useful for testing and debugging.
RespondActivityTaskFailedRequest	withDetails(String details) Optional. Detailed information about the failure.
RespondActivityTaskFailedRequest	withReason(String reason) Description of the error that may assist in diagnostics.
RespondActivityTaskFailedRequest	withTaskToken(String taskToken) The taskToken of the ActivityTask.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

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

Constructor Detail

RespondActivityTaskFailedRequest

public RespondActivityTaskFailedRequest()

Method Detail

getTaskToken

public String getTaskToken()

The taskToken of the ActivityTask. taskToken is generated by the service and should be treated as an opaque value. If the task is passed to another process, its taskToken must also be passed. This enables it to provide its progress and respond with results.

Constraints:
Length: 1 - 1024

Returns:

The taskToken of the ActivityTask. taskToken is generated by the service and should be treated as an opaque value. If the task is passed to another process, its taskToken must also be passed. This enables it to provide its progress and respond with results.

setTaskToken

public void setTaskToken(String taskToken)

The taskToken of the ActivityTask. taskToken is generated by the service and should be treated as an opaque value. If the task is passed to another process, its taskToken must also be passed. This enables it to provide its progress and respond with results.

Constraints:
Length: 1 - 1024

Parameters:

taskToken - The taskToken of the ActivityTask. taskToken is generated by the service and should be treated as an opaque value. If the task is passed to another process, its taskToken must also be passed. This enables it to provide its progress and respond with results.

withTaskToken

public RespondActivityTaskFailedRequest withTaskToken(String taskToken)

The taskToken of the ActivityTask. taskToken is generated by the service and should be treated as an opaque value. If the task is passed to another process, its taskToken must also be passed. This enables it to provide its progress and respond with results.

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

Constraints:
Length: 1 - 1024

Parameters:

taskToken - The taskToken of the ActivityTask. taskToken is generated by the service and should be treated as an opaque value. If the task is passed to another process, its taskToken must also be passed. This enables it to provide its progress and respond with results.

Returns:

A reference to this updated object so that method calls can be chained together.

getReason

public String getReason()

Description of the error that may assist in diagnostics.

Constraints:
Length: 0 - 256

Returns:

Description of the error that may assist in diagnostics.

setReason

public void setReason(String reason)

Description of the error that may assist in diagnostics.

Constraints:
Length: 0 - 256

Parameters:

reason - Description of the error that may assist in diagnostics.

withReason

public RespondActivityTaskFailedRequest withReason(String reason)

Description of the error that may assist in diagnostics.

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

Constraints:
Length: 0 - 256

Parameters:

reason - Description of the error that may assist in diagnostics.

Returns:

A reference to this updated object so that method calls can be chained together.

getDetails

public String getDetails()

Optional. Detailed information about the failure.

Constraints:
Length: 0 - 32768

Returns:

Optional. Detailed information about the failure.

setDetails

public void setDetails(String details)

Optional. Detailed information about the failure.

Constraints:
Length: 0 - 32768

Parameters:

details - Optional. Detailed information about the failure.

withDetails

public RespondActivityTaskFailedRequest withDetails(String details)

Optional. Detailed information about the failure.

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

Constraints:
Length: 0 - 32768

Parameters:

details - Optional. Detailed information about the failure.

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 RespondActivityTaskFailedRequest 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()