com.amazonaws.services.simpleworkflow.model

Class RespondActivityTaskCanceledRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.simpleworkflow.model.RespondActivityTaskCanceledRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class RespondActivityTaskCanceledRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the RespondActivityTaskCanceled operation.

Used by workers to tell the service that the ActivityTask identified by the taskToken was successfully canceled. Additional details can be optionally provided using the details argument.

These details (if provided) appear in the ActivityTaskCanceled event added to the workflow history.

IMPORTANT:Only use this operation if the canceled flag of a RecordActivityTaskHeartbeat request returns true and if the activity can be safely undone or abandoned.

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.respondActivityTaskCanceled(RespondActivityTaskCanceledRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
RespondActivityTaskCanceledRequest()

Method Summary

Methods

Modifier and Type	Method and Description
RespondActivityTaskCanceledRequest	clone() Creates a shallow clone of this request.
boolean	equals(Object obj)
String	getDetails() Optional. Information about the cancellation.
String	getTaskToken() The taskToken of the ActivityTask.
int	hashCode()
void	setDetails(String details) Optional. Information about the cancellation.
void	setTaskToken(String taskToken) The taskToken of the ActivityTask.
String	toString() Returns a string representation of this object; useful for testing and debugging.
RespondActivityTaskCanceledRequest	withDetails(String details) Optional. Information about the cancellation.
RespondActivityTaskCanceledRequest	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, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

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

Constructor Detail

RespondActivityTaskCanceledRequest

public RespondActivityTaskCanceledRequest()

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

getDetails

public String getDetails()

Optional. Information about the cancellation.

Constraints:
Length: 0 - 32768

Returns:

Optional. Information about the cancellation.

setDetails

public void setDetails(String details)

Optional. Information about the cancellation.

Constraints:
Length: 0 - 32768

Parameters:

details - Optional. Information about the cancellation.

withDetails

public RespondActivityTaskCanceledRequest withDetails(String details)

Optional. Information about the cancellation.

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

Constraints:
Length: 0 - 32768

Parameters:

details - Optional. Information about the cancellation.

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