com.amazonaws.services.simpleworkflow.model

Class RespondActivityTaskCompletedRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.simpleworkflow.model.RespondActivityTaskCompletedRequest

All Implemented Interfaces:

Serializable

public class RespondActivityTaskCompletedRequest
extends AmazonWebServiceRequest
implements Serializable

Container for the parameters to the RespondActivityTaskCompleted operation.

Used by workers to tell the service that the ActivityTask identified by the taskToken completed successfully with a result (if provided). The result appears in the ActivityTaskCompleted event in the workflow history.

IMPORTANT: If the requested task does not complete successfully, use RespondActivityTaskFailed instead. If the worker finds that the task is canceled through the canceled flag returned by RecordActivityTaskHeartbeat, it should cancel the task, clean up and then call RespondActivityTaskCanceled.

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 by throwing OperationNotPermitted . For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows .

See Also:

AmazonSimpleWorkflow.respondActivityTaskCompleted(RespondActivityTaskCompletedRequest), Serialized Form

Constructor Summary

Constructors

Constructor and Description
RespondActivityTaskCompletedRequest()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getResult() The result of the activity task.
String	getTaskToken() The taskToken of the ActivityTask.
int	hashCode()
void	setResult(String result) The result of the activity task.
void	setTaskToken(String taskToken) The taskToken of the ActivityTask.
String	toString() Returns a string representation of this object; useful for testing and debugging.
RespondActivityTaskCompletedRequest	withResult(String result) The result of the activity task.
RespondActivityTaskCompletedRequest	withTaskToken(String taskToken) The taskToken of the ActivityTask.

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

RespondActivityTaskCompletedRequest

public RespondActivityTaskCompletedRequest()

Method Detail

getTaskToken

public String getTaskToken()

The taskToken of the ActivityTask. The 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. The 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. The 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. The 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 RespondActivityTaskCompletedRequest withTaskToken(String taskToken)

The taskToken of the ActivityTask. The 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. The 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.

getResult

public String getResult()

The result of the activity task. It is a free form string that is implementation specific.

Constraints:
Length: 0 - 32768

Returns:

The result of the activity task. It is a free form string that is implementation specific.

setResult

public void setResult(String result)

The result of the activity task. It is a free form string that is implementation specific.

Constraints:
Length: 0 - 32768

Parameters:

result - The result of the activity task. It is a free form string that is implementation specific.

withResult

public RespondActivityTaskCompletedRequest withResult(String result)

The result of the activity task. It is a free form string that is implementation specific.

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

Constraints:
Length: 0 - 32768

Parameters:

result - The result of the activity task. It is a free form string that is implementation specific.

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