Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
  /*
   * Copyright 2010-2015 Amazon.com, Inc. or its affiliates. All Rights Reserved.
   * 
   * Licensed under the Apache License, Version 2.0 (the "License").
   * You may not use this file except in compliance with the License.
   * A copy of the License is located at
   * 
   *  http://aws.amazon.com/apache2.0
   * 
  * or in the "license" file accompanying this file. This file is distributed
  * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
  * express or implied. See the License for the specific language governing
  * permissions and limitations under the License.
  */
 package com.amazonaws.services.simpleworkflow.model;
 
 
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. 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 .

 
 public class TerminateWorkflowExecutionRequest extends AmazonWebServiceRequest implements SerializableCloneable {

    
The domain of the workflow execution to terminate.

Constraints:
Length: 1 - 256

 
     private String domain;

    
The workflowId of the workflow execution to terminate.

Constraints:
Length: 1 - 256

 
     private String workflowId;

    
The runId of the workflow execution to terminate.

Constraints:
Length: 0 - 64

 
     private String runId;

    
Optional. A descriptive reason for terminating the workflow execution.

Constraints:
Length: 0 - 256

    private String reason;

    
Optional. Details for terminating the workflow execution.

Constraints:
Length: 0 - 32768

    private String details;

    
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.
<note>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 then a fault will be returned.</note>

Constraints:
Allowed Values: TERMINATE, REQUEST_CANCEL, ABANDON

    private String childPolicy;

    
The domain of the workflow execution to terminate.

Constraints:
Length: 1 - 256

Returns:
The domain of the workflow execution to terminate.
    public String getDomain() {
        return ;
    }
    
    
The domain of the workflow execution to terminate.

Constraints:
Length: 1 - 256

Parameters:
domain The domain of the workflow execution to terminate.
    public void setDomain(String domain) {
        this. = 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

Parameters:
domain The domain of the workflow execution to terminate.
Returns:
A reference to this updated object so that method calls can be chained together.
        this. = domain;
        return this;
    }

    
The workflowId of the workflow execution to terminate.

Constraints:
Length: 1 - 256

Returns:
The workflowId of the workflow execution to terminate.
    public String getWorkflowId() {
        return ;
    }
    
    
The workflowId of the workflow execution to terminate.

Constraints:
Length: 1 - 256

Parameters:
workflowId The workflowId of the workflow execution to terminate.
    public void setWorkflowId(String workflowId) {
        this. = 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

Parameters:
workflowId The workflowId of the workflow execution to terminate.
Returns:
A reference to this updated object so that method calls can be chained together.
        this. = workflowId;
        return this;
    }

    
The runId of the workflow execution to terminate.

Constraints:
Length: 0 - 64

Returns:
The runId of the workflow execution to terminate.
    public String getRunId() {
        return ;
    }
    
    
The runId of the workflow execution to terminate.

Constraints:
Length: 0 - 64

Parameters:
runId The runId of the workflow execution to terminate.
    public void setRunId(String runId) {
        this. = 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

Parameters:
runId The runId of the workflow execution to terminate.
Returns:
A reference to this updated object so that method calls can be chained together.
        this. = runId;
        return this;
    }

    
Optional. A descriptive reason for terminating the workflow execution.

Constraints:
Length: 0 - 256

Returns:
Optional. A descriptive reason for terminating the workflow execution.
    public String getReason() {
        return ;
    }
    
    
Optional. A descriptive reason for terminating the workflow execution.

Constraints:
Length: 0 - 256

Parameters:
reason Optional. A descriptive reason for terminating the workflow execution.
    public void setReason(String reason) {
        this. = reason;
    }
    
    
Optional. A 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

Parameters:
reason Optional. A descriptive reason for terminating the workflow execution.
Returns:
A reference to this updated object so that method calls can be chained together.
        this. = reason;
        return this;
    }

    
Optional. Details for terminating the workflow execution.

Constraints:
Length: 0 - 32768

Returns:
Optional. Details for terminating the workflow execution.
    public String getDetails() {
        return ;
    }
    
    
Optional. Details for terminating the workflow execution.

Constraints:
Length: 0 - 32768

Parameters:
details Optional. Details for terminating the workflow execution.
    public void setDetails(String details) {
        this. = 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

Parameters:
details Optional. Details for terminating the workflow execution.
Returns:
A reference to this updated object so that method calls can be chained together.
        this. = details;
        return this;
    }

    
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.
<note>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 then a fault will be returned.</note>

Constraints:
Allowed Values: TERMINATE, REQUEST_CANCEL, ABANDON

Returns:
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.
<note>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 then a fault will be returned.</note>
See also:
ChildPolicy
    public String getChildPolicy() {
        return ;
    }
    
    
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.
<note>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 then a fault will be returned.</note>

Constraints:
Allowed Values: TERMINATE, REQUEST_CANCEL, ABANDON

Parameters:
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.
<note>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 then a fault will be returned.</note>
See also:
ChildPolicy
    public void setChildPolicy(String childPolicy) {
        this. = 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.
<note>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 then a fault will be returned.</note>

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

Constraints:
Allowed Values: TERMINATE, REQUEST_CANCEL, ABANDON

Parameters:
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.
<note>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 then a fault will be returned.</note>
Returns:
A reference to this updated object so that method calls can be chained together.
See also:
ChildPolicy
        this. = childPolicy;
        return this;
    }

    
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.
<note>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 then a fault will be returned.</note>

Constraints:
Allowed Values: TERMINATE, REQUEST_CANCEL, ABANDON

Parameters:
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.
<note>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 then a fault will be returned.</note>
See also:
ChildPolicy
    public void setChildPolicy(ChildPolicy childPolicy) {
        this. = childPolicy.toString();
    }
    
    
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.
<note>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 then a fault will be returned.</note>

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

Constraints:
Allowed Values: TERMINATE, REQUEST_CANCEL, ABANDON

Parameters:
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.
<note>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 then a fault will be returned.</note>
Returns:
A reference to this updated object so that method calls can be chained together.
See also:
ChildPolicy
        this. = childPolicy.toString();
        return this;
    }

    
Returns a string representation of this object; useful for testing and debugging.

Returns:
A string representation of this object.
See also:
java.lang.Object.toString()
    @Override
    public String toString() {
        StringBuilder sb = new StringBuilder();
        sb.append("{");
        if (getDomain() != nullsb.append("Domain: " + getDomain() + ",");
        if (getWorkflowId() != nullsb.append("WorkflowId: " + getWorkflowId() + ",");
        if (getRunId() != nullsb.append("RunId: " + getRunId() + ",");
        if (getReason() != nullsb.append("Reason: " + getReason() + ",");
        if (getDetails() != nullsb.append("Details: " + getDetails() + ",");
        if (getChildPolicy() != nullsb.append("ChildPolicy: " + getChildPolicy() );
        sb.append("}");
        return sb.toString();
    }
    
    @Override
    public int hashCode() {
        final int prime = 31;
        int hashCode = 1;
        
        hashCode = prime * hashCode + ((getDomain() == null) ? 0 : getDomain().hashCode()); 
        hashCode = prime * hashCode + ((getWorkflowId() == null) ? 0 : getWorkflowId().hashCode()); 
        hashCode = prime * hashCode + ((getRunId() == null) ? 0 : getRunId().hashCode()); 
        hashCode = prime * hashCode + ((getReason() == null) ? 0 : getReason().hashCode()); 
        hashCode = prime * hashCode + ((getDetails() == null) ? 0 : getDetails().hashCode()); 
        hashCode = prime * hashCode + ((getChildPolicy() == null) ? 0 : getChildPolicy().hashCode()); 
        return hashCode;
    }
    
    @Override
    public boolean equals(Object obj) {
        if (this == objreturn true;
        if (obj == nullreturn false;
        if (obj instanceof TerminateWorkflowExecutionRequest == falsereturn false;
        
        if (other.getDomain() == null ^ this.getDomain() == nullreturn false;
        if (other.getDomain() != null && other.getDomain().equals(this.getDomain()) == falsereturn false
        if (other.getWorkflowId() == null ^ this.getWorkflowId() == nullreturn false;
        if (other.getWorkflowId() != null && other.getWorkflowId().equals(this.getWorkflowId()) == falsereturn false
        if (other.getRunId() == null ^ this.getRunId() == nullreturn false;
        if (other.getRunId() != null && other.getRunId().equals(this.getRunId()) == falsereturn false
        if (other.getReason() == null ^ this.getReason() == nullreturn false;
        if (other.getReason() != null && other.getReason().equals(this.getReason()) == falsereturn false
        if (other.getDetails() == null ^ this.getDetails() == nullreturn false;
        if (other.getDetails() != null && other.getDetails().equals(this.getDetails()) == falsereturn false
        if (other.getChildPolicy() == null ^ this.getChildPolicy() == nullreturn false;
        if (other.getChildPolicy() != null && other.getChildPolicy().equals(this.getChildPolicy()) == falsereturn false
        return true;
    }
    
    @Override
        
            return (TerminateWorkflowExecutionRequestsuper.clone();
    }
}
    
New to GrepCode? Check out our FAQ X