com.amazonaws.services.simpleworkflow.model

## クラス TerminateWorkflowExecutionRequest

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

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

      public class TerminateWorkflowExecutionRequest
      extends AmazonWebServiceRequest
      implements java.io.Serializable

  Container for the parameters to the `TerminateWorkflowExecution operation`.

  Records a `WorkflowExecutionTerminated` event and forces closure of the workflow execution identified by the given domain, runId, and workflowId. The child policy, registered with the workflow type or specified when starting this execution, is applied to any open child workflow executions of this workflow execution.

  IMPORTANT: If the identified workflow execution was in progress, it is terminated immediately.

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

  NOTE: You should consider using RequestCancelWorkflowExecution action instead because it allows the workflow to gracefully close while TerminateWorkflowExecution does not.

  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.terminateWorkflowExecution(TerminateWorkflowExecutionRequest)`, 直列化された形式

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

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

  - ### メソッドの概要

    メソッド
    修飾子とタイプ | メソッドと説明
    --- | ---
    `boolean` | `equals(java.lang.Object obj)`
    `java.lang.String` | `getChildPolicy()` If set, specifies the policy to use for the child workflow executions of the workflow execution being terminated.
    `java.lang.String` | `getDetails()` Optional details for terminating the workflow execution.
    `java.lang.String` | `getDomain()` The domain of the workflow execution to terminate.
    `java.lang.String` | `getReason()` An optional descriptive reason for terminating the workflow execution.
    `java.lang.String` | `getRunId()` The runId of the workflow execution to terminate.
    `java.lang.String` | `getWorkflowId()` The workflowId of the workflow execution to terminate.
    `int` | `hashCode()`
    `void` | `setChildPolicy(ChildPolicy childPolicy)` If set, specifies the policy to use for the child workflow executions of the workflow execution being terminated.
    `void` | `setChildPolicy(java.lang.String childPolicy)` If set, specifies the policy to use for the child workflow executions of the workflow execution being terminated.
    `void` | `setDetails(java.lang.String details)` Optional details for terminating the workflow execution.
    `void` | `setDomain(java.lang.String domain)` The domain of the workflow execution to terminate.
    `void` | `setReason(java.lang.String reason)` An optional descriptive reason for terminating the workflow execution.
    `void` | `setRunId(java.lang.String runId)` The runId of the workflow execution to terminate.
    `void` | `setWorkflowId(java.lang.String workflowId)` The workflowId of the workflow execution to terminate.
    `java.lang.String` | `toString()` Returns a string representation of this object; useful for testing and debugging.
    `TerminateWorkflowExecutionRequest` | `withChildPolicy(ChildPolicy childPolicy)` If set, specifies the policy to use for the child workflow executions of the workflow execution being terminated.
    `TerminateWorkflowExecutionRequest` | `withChildPolicy(java.lang.String childPolicy)` If set, specifies the policy to use for the child workflow executions of the workflow execution being terminated.
    `TerminateWorkflowExecutionRequest` | `withDetails(java.lang.String details)` Optional details for terminating the workflow execution.
    `TerminateWorkflowExecutionRequest` | `withDomain(java.lang.String domain)` The domain of the workflow execution to terminate.
    `TerminateWorkflowExecutionRequest` | `withReason(java.lang.String reason)` An optional descriptive reason for terminating the workflow execution.
    `TerminateWorkflowExecutionRequest` | `withRunId(java.lang.String runId)` The runId of the workflow execution to terminate.
    `TerminateWorkflowExecutionRequest` | `withWorkflowId(java.lang.String workflowId)` The workflowId of the workflow execution to terminate.

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

      `copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, setRequestCredentials`

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

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

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

    - #### TerminateWorkflowExecutionRequest

          public TerminateWorkflowExecutionRequest()

  - ### メソッドの詳細

    - #### getDomain

          public java.lang.String getDomain()

      The domain of the workflow execution to terminate.

      Constraints:
      Length: 1 - 256

      戻り値:
        The domain of the workflow execution to terminate.

    - #### setDomain

          public void setDomain(java.lang.String domain)

      The domain of the workflow execution to terminate.

      Constraints:
      Length: 1 - 256

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

    - #### withDomain

          public TerminateWorkflowExecutionRequest withDomain(java.lang.String domain)

      The domain of the workflow execution to terminate.

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

      Constraints:
      Length: 1 - 256

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

    - #### getWorkflowId

          public java.lang.String getWorkflowId()

      The workflowId of the workflow execution to terminate.

      Constraints:
      Length: 1 - 256

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

    - #### setWorkflowId

          public void setWorkflowId(java.lang.String workflowId)

      The workflowId of the workflow execution to terminate.

      Constraints:
      Length: 1 - 256

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

    - #### withWorkflowId

          public TerminateWorkflowExecutionRequest withWorkflowId(java.lang.String workflowId)

      The workflowId of the workflow execution to terminate.

      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 terminate.

    - #### getRunId

          public java.lang.String getRunId()

      The runId of the workflow execution to terminate.

      Constraints:
      Length: 0 - 64

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

    - #### setRunId

          public void setRunId(java.lang.String runId)

      The runId of the workflow execution to terminate.

      Constraints:
      Length: 0 - 64

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

    - #### withRunId

          public TerminateWorkflowExecutionRequest withRunId(java.lang.String runId)

      The runId of the workflow execution to terminate.

      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 terminate.

    - #### getReason

          public java.lang.String getReason()

      An optional descriptive reason for terminating the workflow execution.

      Constraints:
      Length: 0 - 256

      戻り値:
        An optional descriptive reason for terminating the workflow execution.

    - #### setReason

          public void setReason(java.lang.String reason)

      An optional descriptive reason for terminating the workflow execution.

      Constraints:
      Length: 0 - 256

      パラメータ:
        `reason` - An optional descriptive reason for terminating the workflow execution.

    - #### withReason

          public TerminateWorkflowExecutionRequest withReason(java.lang.String reason)

      An optional descriptive reason for terminating the workflow execution.

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

      Constraints:
      Length: 0 - 256

      パラメータ:
        `reason` - An optional descriptive reason for terminating the workflow execution.

    - #### getDetails

          public java.lang.String getDetails()

      Optional details for terminating the workflow execution.

      Constraints:
      Length: 0 - 32768

      戻り値:
        Optional details for terminating the workflow execution.

    - #### setDetails

          public void setDetails(java.lang.String details)

      Optional details for terminating the workflow execution.

      Constraints:
      Length: 0 - 32768

      パラメータ:
        `details` - Optional details for terminating the workflow execution.

    - #### withDetails

          public TerminateWorkflowExecutionRequest withDetails(java.lang.String details)

      Optional details for terminating the workflow execution.

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

      Constraints:
      Length: 0 - 32768

      パラメータ:
        `details` - Optional details for terminating the workflow execution.

    - #### getChildPolicy

          public java.lang.String getChildPolicy()

      If set, specifies the policy to use for the child workflow executions of the workflow execution being terminated. This policy overrides the child policy specified for the workflow execution at registration time or when starting the execution. The supported child policies are:
      - TERMINATE: the child executions will be terminated.
      - REQUEST_CANCEL: a request to cancel will be attempted for each child execution by recording a `WorkflowExecutionCancelRequested` event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.
      - ABANDON: no action will be taken. The child executions will continue to run.
      A child policy for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default child policy was specified at registration time, a fault will be returned.

      Constraints:
      Allowed Values: TERMINATE, REQUEST_CANCEL, ABANDON

      戻り値:
        If set, specifies the policy to use for the child workflow executions of the workflow execution being terminated. This policy overrides the child policy specified for the workflow execution at registration time or when starting the execution. The supported child policies are:
        - TERMINATE: the child executions will be terminated.
        - REQUEST_CANCEL: a request to cancel will be attempted for each child execution by recording a `WorkflowExecutionCancelRequested` event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.
        - ABANDON: no action will be taken. The child executions will continue to run.
        A child policy for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default child policy was specified at registration time, a fault will be returned.
      関連項目:
        `ChildPolicy`

    - #### setChildPolicy

          public void setChildPolicy(java.lang.String childPolicy)

      If set, specifies the policy to use for the child workflow executions of the workflow execution being terminated. This policy overrides the child policy specified for the workflow execution at registration time or when starting the execution. The supported child policies are:
      - TERMINATE: the child executions will be terminated.
      - REQUEST_CANCEL: a request to cancel will be attempted for each child execution by recording a `WorkflowExecutionCancelRequested` event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.
      - ABANDON: no action will be taken. The child executions will continue to run.
      A child policy for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default child policy was specified at registration time, a fault will be returned.

      Constraints:
      Allowed Values: TERMINATE, REQUEST_CANCEL, ABANDON

      パラメータ:
        `childPolicy` - If set, specifies the policy to use for the child workflow executions of the workflow execution being terminated. This policy overrides the child policy specified for the workflow execution at registration time or when starting the execution. The supported child policies are:
        - TERMINATE: the child executions will be terminated.
        - REQUEST_CANCEL: a request to cancel will be attempted for each child execution by recording a `WorkflowExecutionCancelRequested` event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.
        - ABANDON: no action will be taken. The child executions will continue to run.
        A child policy for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default child policy was specified at registration time, a fault will be returned.
      関連項目:
        `ChildPolicy`

    - #### withChildPolicy

          public TerminateWorkflowExecutionRequest withChildPolicy(java.lang.String childPolicy)

      If set, specifies the policy to use for the child workflow executions of the workflow execution being terminated. This policy overrides the child policy specified for the workflow execution at registration time or when starting the execution. The supported child policies are:
      - TERMINATE: the child executions will be terminated.
      - REQUEST_CANCEL: a request to cancel will be attempted for each child execution by recording a `WorkflowExecutionCancelRequested` event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.
      - ABANDON: no action will be taken. The child executions will continue to run.
      A child policy for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default child policy was specified at registration time, a fault will be returned.

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

      Constraints:
      Allowed Values: TERMINATE, REQUEST_CANCEL, ABANDON

      パラメータ:
        `childPolicy` - If set, specifies the policy to use for the child workflow executions of the workflow execution being terminated. This policy overrides the child policy specified for the workflow execution at registration time or when starting the execution. The supported child policies are:
        - TERMINATE: the child executions will be terminated.
        - REQUEST_CANCEL: a request to cancel will be attempted for each child execution by recording a `WorkflowExecutionCancelRequested` event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.
        - ABANDON: no action will be taken. The child executions will continue to run.
        A child policy for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default child policy was specified at registration time, a fault will be returned.
      関連項目:
        `ChildPolicy`

    - #### setChildPolicy

          public void setChildPolicy(ChildPolicy childPolicy)

      If set, specifies the policy to use for the child workflow executions of the workflow execution being terminated. This policy overrides the child policy specified for the workflow execution at registration time or when starting the execution. The supported child policies are:
      - TERMINATE: the child executions will be terminated.
      - REQUEST_CANCEL: a request to cancel will be attempted for each child execution by recording a `WorkflowExecutionCancelRequested` event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.
      - ABANDON: no action will be taken. The child executions will continue to run.
      A child policy for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default child policy was specified at registration time, a fault will be returned.

      Constraints:
      Allowed Values: TERMINATE, REQUEST_CANCEL, ABANDON

      パラメータ:
        `childPolicy` - If set, specifies the policy to use for the child workflow executions of the workflow execution being terminated. This policy overrides the child policy specified for the workflow execution at registration time or when starting the execution. The supported child policies are:
        - TERMINATE: the child executions will be terminated.
        - REQUEST_CANCEL: a request to cancel will be attempted for each child execution by recording a `WorkflowExecutionCancelRequested` event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.
        - ABANDON: no action will be taken. The child executions will continue to run.
        A child policy for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default child policy was specified at registration time, a fault will be returned.
      関連項目:
        `ChildPolicy`

    - #### withChildPolicy

          public TerminateWorkflowExecutionRequest withChildPolicy(ChildPolicy childPolicy)

      If set, specifies the policy to use for the child workflow executions of the workflow execution being terminated. This policy overrides the child policy specified for the workflow execution at registration time or when starting the execution. The supported child policies are:
      - TERMINATE: the child executions will be terminated.
      - REQUEST_CANCEL: a request to cancel will be attempted for each child execution by recording a `WorkflowExecutionCancelRequested` event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.
      - ABANDON: no action will be taken. The child executions will continue to run.
      A child policy for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default child policy was specified at registration time, a fault will be returned.

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

      Constraints:
      Allowed Values: TERMINATE, REQUEST_CANCEL, ABANDON

      パラメータ:
        `childPolicy` - If set, specifies the policy to use for the child workflow executions of the workflow execution being terminated. This policy overrides the child policy specified for the workflow execution at registration time or when starting the execution. The supported child policies are:
        - TERMINATE: the child executions will be terminated.
        - REQUEST_CANCEL: a request to cancel will be attempted for each child execution by recording a `WorkflowExecutionCancelRequested` event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.
        - ABANDON: no action will be taken. The child executions will continue to run.
        A child policy for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default child policy was specified at registration time, a fault will be returned.
      関連項目:
        `ChildPolicy`

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