com.amazonaws.services.simpleworkflow.model

Class SignalExternalWorkflowExecutionDecisionAttributes

java.lang.Object

com.amazonaws.services.simpleworkflow.model.SignalExternalWorkflowExecutionDecisionAttributes

All Implemented Interfaces:

Serializable

public class SignalExternalWorkflowExecutionDecisionAttributes
extends Object
implements Serializable

Provides details of the SignalExternalWorkflowExecution decision.

Access Control

You can use IAM policies to control this decision's access to Amazon SWF in much the same way as for the regular API:

• Use a Resource element with the domain name to limit the decision to only specified domains.
• Use an Action element to allow or deny permission to specify this decision.
• 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:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SignalExternalWorkflowExecutionDecisionAttributes()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getControl() Optional data attached to the event that can be used by the decider in subsequent decision tasks.
String	getInput() Optional input to be provided with the signal.The target workflow execution will use the signal name and input to process the signal.
String	getRunId() The runId of the workflow execution to be signaled.
String	getSignalName() The name of the signal.The target workflow execution will use the signal name and input to process the signal.
String	getWorkflowId() The workflowId of the workflow execution to be signaled.
int	hashCode()
void	setControl(String control) Optional data attached to the event that can be used by the decider in subsequent decision tasks.
void	setInput(String input) Optional input to be provided with the signal.The target workflow execution will use the signal name and input to process the signal.
void	setRunId(String runId) The runId of the workflow execution to be signaled.
void	setSignalName(String signalName) The name of the signal.The target workflow execution will use the signal name and input to process the signal.
void	setWorkflowId(String workflowId) The workflowId of the workflow execution to be signaled.
String	toString() Returns a string representation of this object; useful for testing and debugging.
SignalExternalWorkflowExecutionDecisionAttributes	withControl(String control) Optional data attached to the event that can be used by the decider in subsequent decision tasks.
SignalExternalWorkflowExecutionDecisionAttributes	withInput(String input) Optional input to be provided with the signal.The target workflow execution will use the signal name and input to process the signal.
SignalExternalWorkflowExecutionDecisionAttributes	withRunId(String runId) The runId of the workflow execution to be signaled.
SignalExternalWorkflowExecutionDecisionAttributes	withSignalName(String signalName) The name of the signal.The target workflow execution will use the signal name and input to process the signal.
SignalExternalWorkflowExecutionDecisionAttributes	withWorkflowId(String workflowId) The workflowId of the workflow execution to be signaled.

Methods inherited from class java.lang.Object

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

Constructor Detail

SignalExternalWorkflowExecutionDecisionAttributes

public SignalExternalWorkflowExecutionDecisionAttributes()

Method Detail

getWorkflowId

public String getWorkflowId()

The workflowId of the workflow execution to be signaled. This field is required.

Constraints:
Length: 1 - 256

Returns:

The workflowId of the workflow execution to be signaled. This field is required.

setWorkflowId

public void setWorkflowId(String workflowId)

The workflowId of the workflow execution to be signaled. This field is required.

Constraints:
Length: 1 - 256

Parameters:

workflowId - The workflowId of the workflow execution to be signaled. This field is required.

withWorkflowId

public SignalExternalWorkflowExecutionDecisionAttributes withWorkflowId(String workflowId)

The workflowId of the workflow execution to be signaled. This field is required.

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 be signaled. This field is required.

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

Constraints:
Length: 0 - 64

Returns:

The runId of the workflow execution to be signaled.

setRunId

public void setRunId(String runId)

The runId of the workflow execution to be signaled.

Constraints:
Length: 0 - 64

Parameters:

runId - The runId of the workflow execution to be signaled.

withRunId

public SignalExternalWorkflowExecutionDecisionAttributes withRunId(String runId)

The runId of the workflow execution to be signaled.

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

Returns:

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

getSignalName

public String getSignalName()

The name of the signal.The target workflow execution will use the signal name and input to process the signal. This field is required.

Constraints:
Length: 1 - 256

Returns:

The name of the signal.The target workflow execution will use the signal name and input to process the signal. This field is required.

setSignalName

public void setSignalName(String signalName)

The name of the signal.The target workflow execution will use the signal name and input to process the signal. This field is required.

Constraints:
Length: 1 - 256

Parameters:

signalName - The name of the signal.The target workflow execution will use the signal name and input to process the signal. This field is required.

withSignalName

public SignalExternalWorkflowExecutionDecisionAttributes withSignalName(String signalName)

The name of the signal.The target workflow execution will use the signal name and input to process the signal. This field is required.

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

Constraints:
Length: 1 - 256

Parameters:

signalName - The name of the signal.The target workflow execution will use the signal name and input to process the signal. This field is required.

Returns:

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

getInput

public String getInput()

Optional input to be provided with the signal.The target workflow execution will use the signal name and input to process the signal.

Constraints:
Length: 0 - 32768

Returns:

Optional input to be provided with the signal.The target workflow execution will use the signal name and input to process the signal.

setInput

public void setInput(String input)

Optional input to be provided with the signal.The target workflow execution will use the signal name and input to process the signal.

Constraints:
Length: 0 - 32768

Parameters:

input - Optional input to be provided with the signal.The target workflow execution will use the signal name and input to process the signal.

withInput

public SignalExternalWorkflowExecutionDecisionAttributes withInput(String input)

Optional input to be provided with the signal.The target workflow execution will use the signal name and input to process the signal.

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

Constraints:
Length: 0 - 32768

Parameters:

input - Optional input to be provided with the signal.The target workflow execution will use the signal name and input to process the signal.

Returns:

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

getControl

public String getControl()

Optional data attached to the event that can be used by the decider in subsequent decision tasks.

Constraints:
Length: 0 - 32768

Returns:

Optional data attached to the event that can be used by the decider in subsequent decision tasks.

setControl

public void setControl(String control)

Optional data attached to the event that can be used by the decider in subsequent decision tasks.

Constraints:
Length: 0 - 32768

Parameters:

control - Optional data attached to the event that can be used by the decider in subsequent decision tasks.

withControl

public SignalExternalWorkflowExecutionDecisionAttributes withControl(String control)

Optional data attached to the event that can be used by the decider in subsequent decision tasks.

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

Constraints:
Length: 0 - 32768

Parameters:

control - Optional data attached to the event that can be used by the decider in subsequent decision tasks.

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