com.amazonaws.services.simpleworkflow.model

## クラス RequestCancelWorkflowExecutionRequest

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

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

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

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

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

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

  - ### メソッドの概要

    メソッド
    修飾子とタイプ | メソッドと説明
    --- | ---
    `boolean` | `equals(java.lang.Object obj)`
    `java.lang.String` | `getDomain()` The name of the domain containing the workflow execution to cancel.
    `java.lang.String` | `getRunId()` The runId of the workflow execution to cancel.
    `java.lang.String` | `getWorkflowId()` The workflowId of the workflow execution to cancel.
    `int` | `hashCode()`
    `void` | `setDomain(java.lang.String domain)` The name of the domain containing the workflow execution to cancel.
    `void` | `setRunId(java.lang.String runId)` The runId of the workflow execution to cancel.
    `void` | `setWorkflowId(java.lang.String workflowId)` The workflowId of the workflow execution to cancel.
    `java.lang.String` | `toString()` Returns a string representation of this object; useful for testing and debugging.
    `RequestCancelWorkflowExecutionRequest` | `withDomain(java.lang.String domain)` The name of the domain containing the workflow execution to cancel.
    `RequestCancelWorkflowExecutionRequest` | `withRunId(java.lang.String runId)` The runId of the workflow execution to cancel.
    `RequestCancelWorkflowExecutionRequest` | `withWorkflowId(java.lang.String workflowId)` The workflowId of the workflow execution to cancel.

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

      `copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, setRequestCredentials`

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

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

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

    - #### RequestCancelWorkflowExecutionRequest

          public RequestCancelWorkflowExecutionRequest()

  - ### メソッドの詳細

    - #### getDomain

          public java.lang.String getDomain()

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

      Constraints:
      Length: 1 - 256

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

    - #### setDomain

          public void setDomain(java.lang.String domain)

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

      Constraints:
      Length: 1 - 256

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

    - #### withDomain

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

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

    - #### getWorkflowId

          public java.lang.String getWorkflowId()

      The workflowId of the workflow execution to cancel.

      Constraints:
      Length: 1 - 256

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

    - #### setWorkflowId

          public void setWorkflowId(java.lang.String workflowId)

      The workflowId of the workflow execution to cancel.

      Constraints:
      Length: 1 - 256

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

    - #### withWorkflowId

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

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

    - #### getRunId

          public java.lang.String getRunId()

      The runId of the workflow execution to cancel.

      Constraints:
      Length: 0 - 64

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

    - #### setRunId

          public void setRunId(java.lang.String runId)

      The runId of the workflow execution to cancel.

      Constraints:
      Length: 0 - 64

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

    - #### withRunId

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

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

    - #### 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`