SignalWorkflowExecutionRequest (AWS SDK for Java 1.7.4.1 API)

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.simpleworkflow.model.SignalWorkflowExecutionRequest

All Implemented Interfaces:

Serializable
```
public class SignalWorkflowExecutionRequest
extends AmazonWebServiceRequest
implements Serializable
```
Container for the parameters to the SignalWorkflowExecution operation.
Records a WorkflowExecutionSignaled event in the workflow execution history and creates a decision task for the workflow execution identified by the given domain, workflowId and runId. The event is recorded with the specified user defined signalName and input (if provided).

NOTE: If a runId is not specified, then the WorkflowExecutionSignaled event is recorded in the history of the current open workflow with the matching workflowId in the domain.

NOTE: If the specified workflow execution is not open, this method fails with UnknownResource.

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.signalWorkflowExecution(SignalWorkflowExecutionRequest), Serialized Form

Constructor Summary

Constructors
Constructor and Description

SignalWorkflowExecutionRequest()

Constructors
Constructor and Description
`SignalWorkflowExecutionRequest()`

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 signal.
`String`	`getInput()` Data to attach to the `WorkflowExecutionSignaled` event in the target workflow execution's history.
`String`	`getRunId()` The runId of the workflow execution to signal.
`String`	`getSignalName()` The name of the signal.
`String`	`getWorkflowId()` The workflowId of the workflow execution to signal.
`int`	`hashCode()`
`void`	`setDomain(String domain)` The name of the domain containing the workflow execution to signal.
`void`	`setInput(String input)` Data to attach to the `WorkflowExecutionSignaled` event in the target workflow execution's history.
`void`	`setRunId(String runId)` The runId of the workflow execution to signal.
`void`	`setSignalName(String signalName)` The name of the signal.
`void`	`setWorkflowId(String workflowId)` The workflowId of the workflow execution to signal.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`SignalWorkflowExecutionRequest`	`withDomain(String domain)` The name of the domain containing the workflow execution to signal.
`SignalWorkflowExecutionRequest`	`withInput(String input)` Data to attach to the `WorkflowExecutionSignaled` event in the target workflow execution's history.
`SignalWorkflowExecutionRequest`	`withRunId(String runId)` The runId of the workflow execution to signal.
`SignalWorkflowExecutionRequest`	`withSignalName(String signalName)` The name of the signal.
`SignalWorkflowExecutionRequest`	`withWorkflowId(String workflowId)` The workflowId of the workflow execution to signal.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setRequestCredentials, setRequestMetricCollector, withRequestMetricCollector

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - SignalWorkflowExecutionRequest
```
public SignalWorkflowExecutionRequest()
```
- Method Detail
  - getDomain
```
public String getDomain()
```
    The name of the domain containing the workflow execution to signal.
    Constraints:
    Length: 1 - 256
    
    Returns:
    The name of the domain containing the workflow execution to signal.
  - setDomain
```
public void setDomain(String domain)
```
    The name of the domain containing the workflow execution to signal.
    Constraints:
    Length: 1 - 256
    
    Parameters:
    domain - The name of the domain containing the workflow execution to signal.
  - withDomain
```
public SignalWorkflowExecutionRequest withDomain(String domain)
```
    The name of the domain containing the workflow execution to signal.
    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 signal.
    
    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 signal.
    Constraints:
    Length: 1 - 256
    
    Returns:
    The workflowId of the workflow execution to signal.
  - setWorkflowId
```
public void setWorkflowId(String workflowId)
```
    The workflowId of the workflow execution to signal.
    Constraints:
    Length: 1 - 256
    
    Parameters:
    workflowId - The workflowId of the workflow execution to signal.
  - withWorkflowId
```
public SignalWorkflowExecutionRequest withWorkflowId(String workflowId)
```
    The workflowId of the workflow execution to signal.
    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 signal.
    
    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 signal.
    Constraints:
    Length: 0 - 64
    
    Returns:
    The runId of the workflow execution to signal.
  - setRunId
```
public void setRunId(String runId)
```
    The runId of the workflow execution to signal.
    Constraints:
    Length: 0 - 64
    
    Parameters:
    runId - The runId of the workflow execution to signal.
  - withRunId
```
public SignalWorkflowExecutionRequest withRunId(String runId)
```
    The runId of the workflow execution to signal.
    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 signal.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getSignalName
```
public String getSignalName()
```
    The name of the signal. This name must be meaningful to the target workflow.
    Constraints:
    Length: 1 - 256
    
    Returns:
    The name of the signal. This name must be meaningful to the target workflow.
  - setSignalName
```
public void setSignalName(String signalName)
```
    The name of the signal. This name must be meaningful to the target workflow.
    Constraints:
    Length: 1 - 256
    
    Parameters:
    signalName - The name of the signal. This name must be meaningful to the target workflow.
  - withSignalName
```
public SignalWorkflowExecutionRequest withSignalName(String signalName)
```
    The name of the signal. This name must be meaningful to the target workflow.
    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. This name must be meaningful to the target workflow.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getInput
```
public String getInput()
```
    Data to attach to the WorkflowExecutionSignaled event in the target workflow execution's history.
    Constraints:
    Length: 0 - 32768
    
    Returns:
    Data to attach to the WorkflowExecutionSignaled event in the target workflow execution's history.
  - setInput
```
public void setInput(String input)
```
    Data to attach to the WorkflowExecutionSignaled event in the target workflow execution's history.
    Constraints:
    Length: 0 - 32768
    
    Parameters:
    input - Data to attach to the WorkflowExecutionSignaled event in the target workflow execution's history.
  - withInput
```
public SignalWorkflowExecutionRequest withInput(String input)
```
    Data to attach to the WorkflowExecutionSignaled event in the target workflow execution's history.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 0 - 32768
    
    Parameters:
    input - Data to attach to the WorkflowExecutionSignaled event in the target workflow execution's history.
    
    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

Class SignalWorkflowExecutionRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

SignalWorkflowExecutionRequest

Method Detail

getDomain

setDomain

withDomain

getWorkflowId

setWorkflowId

withWorkflowId

getRunId

setRunId

withRunId

getSignalName

setSignalName

withSignalName

getInput

setInput

withInput

toString

hashCode

equals