com.amazonaws.services.simpleworkflow.model

## クラス SignalWorkflowExecutionRequest

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

- すべての実装されたインタフェース:
    java.io.Serializable

      public class SignalWorkflowExecutionRequest
      extends AmazonWebServiceRequest
      implements java.io.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 .

  関連項目:
    `AmazonSimpleWorkflow.signalWorkflowExecution(SignalWorkflowExecutionRequest)`, 直列化された形式

- - ### コンストラクタの概要

    コンストラクタ
    コンストラクタと説明
    `SignalWorkflowExecutionRequest()`

  - ### メソッドの概要

    メソッド
    修飾子とタイプ | メソッドと説明
    --- | ---
    `boolean` | `equals(java.lang.Object obj)`
    `java.lang.String` | `getDomain()` The name of the domain containing the workflow execution to signal.
    `java.lang.String` | `getInput()` Data to attach to the `WorkflowExecutionSignaled` event in the target workflow execution's history.
    `java.lang.String` | `getRunId()` The runId of the workflow execution to signal.
    `java.lang.String` | `getSignalName()` The name of the signal.
    `java.lang.String` | `getWorkflowId()` The workflowId of the workflow execution to signal.
    `int` | `hashCode()`
    `void` | `setDomain(java.lang.String domain)` The name of the domain containing the workflow execution to signal.
    `void` | `setInput(java.lang.String input)` Data to attach to the `WorkflowExecutionSignaled` event in the target workflow execution's history.
    `void` | `setRunId(java.lang.String runId)` The runId of the workflow execution to signal.
    `void` | `setSignalName(java.lang.String signalName)` The name of the signal.
    `void` | `setWorkflowId(java.lang.String workflowId)` The workflowId of the workflow execution to signal.
    `java.lang.String` | `toString()` Returns a string representation of this object; useful for testing and debugging.
    `SignalWorkflowExecutionRequest` | `withDomain(java.lang.String domain)` The name of the domain containing the workflow execution to signal.
    `SignalWorkflowExecutionRequest` | `withInput(java.lang.String input)` Data to attach to the `WorkflowExecutionSignaled` event in the target workflow execution's history.
    `SignalWorkflowExecutionRequest` | `withRunId(java.lang.String runId)` The runId of the workflow execution to signal.
    `SignalWorkflowExecutionRequest` | `withSignalName(java.lang.String signalName)` The name of the signal.
    `SignalWorkflowExecutionRequest` | `withWorkflowId(java.lang.String workflowId)` The workflowId of the workflow execution to signal.

    - ### クラスから継承されたメソッド com.amazonaws.AmazonWebServiceRequest

      `copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, setRequestCredentials`

    - ### クラスから継承されたメソッド java.lang.Object

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

- - ### コンストラクタの詳細

    - #### SignalWorkflowExecutionRequest

          public SignalWorkflowExecutionRequest()

  - ### メソッドの詳細

    - #### getDomain

          public java.lang.String getDomain()

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

      Constraints:
      Length: 1 - 256

      戻り値:
        The name of the domain containing the workflow execution to signal.

    - #### setDomain

          public void setDomain(java.lang.String domain)

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

      Constraints:
      Length: 1 - 256

      パラメータ:
        `domain` - The name of the domain containing the workflow execution to signal.

    - #### withDomain

          public SignalWorkflowExecutionRequest withDomain(java.lang.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

      パラメータ:
        `domain` - The name of the domain containing the workflow execution to signal.

    - #### getWorkflowId

          public java.lang.String getWorkflowId()

      The workflowId of the workflow execution to signal.

      Constraints:
      Length: 1 - 256

      戻り値:
        The workflowId of the workflow execution to signal.

    - #### setWorkflowId

          public void setWorkflowId(java.lang.String workflowId)

      The workflowId of the workflow execution to signal.

      Constraints:
      Length: 1 - 256

      パラメータ:
        `workflowId` - The workflowId of the workflow execution to signal.

    - #### withWorkflowId

          public SignalWorkflowExecutionRequest withWorkflowId(java.lang.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

      パラメータ:
        `workflowId` - The workflowId of the workflow execution to signal.

    - #### getRunId

          public java.lang.String getRunId()

      The runId of the workflow execution to signal.

      Constraints:
      Length: 0 - 64

      戻り値:
        The runId of the workflow execution to signal.

    - #### setRunId

          public void setRunId(java.lang.String runId)

      The runId of the workflow execution to signal.

      Constraints:
      Length: 0 - 64

      パラメータ:
        `runId` - The runId of the workflow execution to signal.

    - #### withRunId

          public SignalWorkflowExecutionRequest withRunId(java.lang.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

      パラメータ:
        `runId` - The runId of the workflow execution to signal.

    - #### getSignalName

          public java.lang.String getSignalName()

      The name of the signal. This name must be meaningful to the target workflow.

      Constraints:
      Length: 1 - 256

      戻り値:
        The name of the signal. This name must be meaningful to the target workflow.

    - #### setSignalName

          public void setSignalName(java.lang.String signalName)

      The name of the signal. This name must be meaningful to the target workflow.

      Constraints:
      Length: 1 - 256

      パラメータ:
        `signalName` - The name of the signal. This name must be meaningful to the target workflow.

    - #### withSignalName

          public SignalWorkflowExecutionRequest withSignalName(java.lang.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

      パラメータ:
        `signalName` - The name of the signal. This name must be meaningful to the target workflow.

    - #### getInput

          public java.lang.String getInput()

      Data to attach to the `WorkflowExecutionSignaled` event in the target workflow execution's history.

      Constraints:
      Length: 0 - 32768

      戻り値:
        Data to attach to the `WorkflowExecutionSignaled` event in the target workflow execution's history.

    - #### setInput

          public void setInput(java.lang.String input)

      Data to attach to the `WorkflowExecutionSignaled` event in the target workflow execution's history.

      Constraints:
      Length: 0 - 32768

      パラメータ:
        `input` - Data to attach to the `WorkflowExecutionSignaled` event in the target workflow execution's history.

    - #### withInput

          public SignalWorkflowExecutionRequest withInput(java.lang.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

      パラメータ:
        `input` - Data to attach to the `WorkflowExecutionSignaled` event in the target workflow execution's history.

    - #### toString

          public java.lang.String toString()

      Returns a string representation of this object; useful for testing and debugging.
      オーバーライド:
        `toString` クラス内 `java.lang.Object`
      戻り値:
        A string representation of this object.
      関連項目:
        `Object.toString()`

    - #### hashCode

          public int hashCode()

      オーバーライド:
        `hashCode` クラス内 `java.lang.Object`

    - #### equals

          public boolean equals(java.lang.Object obj)

      オーバーライド:
        `equals` クラス内 `java.lang.Object`