com.amazonaws.services.simpleworkflow.model

Class RequestCancelWorkflowExecutionRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.simpleworkflow.model.RequestCancelWorkflowExecutionRequest

All Implemented Interfaces:

Serializable

public class RequestCancelWorkflowExecutionRequest
extends AmazonWebServiceRequest
implements Serializable

Container for the parameters to the RequestCancelWorkflowExecution operation.

Records a WorkflowExecutionCancelRequested event in the currently running workflow execution identified by the given domain, workflowId, and runId. This logically requests the cancellation of the workflow execution as a whole. It is up to the decider to take appropriate actions when it receives an execution history with this event.

NOTE: If the runId is not specified, the WorkflowExecutionCancelRequested event is recorded in the history of the current open workflow execution with the specified workflowId in the domain.

NOTE: Because this action allows the workflow to properly clean up and gracefully close, it should be used instead of TerminateWorkflowExecution when possible.

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.requestCancelWorkflowExecution(RequestCancelWorkflowExecutionRequest), Serialized Form

Constructor Summary

Constructors

Constructor and Description
RequestCancelWorkflowExecutionRequest()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getDomain() The name of the domain containing the workflow execution to cancel.
String	getRunId() The runId of the workflow execution to cancel.
String	getWorkflowId() The workflowId of the workflow execution to cancel.
int	hashCode()
void	setDomain(String domain) The name of the domain containing the workflow execution to cancel.
void	setRunId(String runId) The runId of the workflow execution to cancel.
void	setWorkflowId(String workflowId) The workflowId of the workflow execution to cancel.
String	toString() Returns a string representation of this object; useful for testing and debugging.
RequestCancelWorkflowExecutionRequest	withDomain(String domain) The name of the domain containing the workflow execution to cancel.
RequestCancelWorkflowExecutionRequest	withRunId(String runId) The runId of the workflow execution to cancel.
RequestCancelWorkflowExecutionRequest	withWorkflowId(String workflowId) The workflowId of the workflow execution to cancel.

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

RequestCancelWorkflowExecutionRequest

public RequestCancelWorkflowExecutionRequest()

Method Detail

getDomain

public String getDomain()

The name of the domain containing the workflow execution to cancel.

Constraints:
Length: 1 - 256

Returns:

The name of the domain containing the workflow execution to cancel.

setDomain

public void setDomain(String domain)

The name of the domain containing the workflow execution to cancel.

Constraints:
Length: 1 - 256

Parameters:

domain - The name of the domain containing the workflow execution to cancel.

withDomain

public RequestCancelWorkflowExecutionRequest withDomain(String domain)

The name of the domain containing the workflow execution to cancel.

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

Constraints:
Length: 1 - 256

Parameters:

domain - The name of the domain containing the workflow execution to cancel.

Returns:

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

getWorkflowId

public String getWorkflowId()

The workflowId of the workflow execution to cancel.

Constraints:
Length: 1 - 256

Returns:

The workflowId of the workflow execution to cancel.

setWorkflowId

public void setWorkflowId(String workflowId)

The workflowId of the workflow execution to cancel.

Constraints:
Length: 1 - 256

Parameters:

workflowId - The workflowId of the workflow execution to cancel.

withWorkflowId

public RequestCancelWorkflowExecutionRequest withWorkflowId(String workflowId)

The workflowId of the workflow execution to cancel.

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

Constraints:
Length: 1 - 256

Parameters:

workflowId - The workflowId of the workflow execution to cancel.

Returns:

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

getRunId

public String getRunId()

The runId of the workflow execution to cancel.

Constraints:
Length: 0 - 64

Returns:

The runId of the workflow execution to cancel.

setRunId

public void setRunId(String runId)

The runId of the workflow execution to cancel.

Constraints:
Length: 0 - 64

Parameters:

runId - The runId of the workflow execution to cancel.

withRunId

public RequestCancelWorkflowExecutionRequest withRunId(String runId)

The runId of the workflow execution to cancel.

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

Constraints:
Length: 0 - 64

Parameters:

runId - The runId of the workflow execution to cancel.

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