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 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. 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 RequestCancelWorkflowExecutionRequest extends AmazonWebServiceRequest implements SerializableCloneable {

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

Constraints:
Length: 1 - 256

 
     private String domain;

    
The workflowId of the workflow execution to cancel.

Constraints:
Length: 1 - 256

 
     private String workflowId;

    
The runId of the workflow execution to cancel.

Constraints:
Length: 0 - 64

 
     private String runId;

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

Constraints:
Length: 1 - 256

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

Constraints:
Length: 1 - 256

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

Parameters:
domain The name of the domain containing the workflow execution to cancel.
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 cancel.

Constraints:
Length: 1 - 256

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

Constraints:
Length: 1 - 256

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

Parameters:
workflowId The workflowId of the workflow execution to cancel.
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 cancel.

Constraints:
Length: 0 - 64

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

Constraints:
Length: 0 - 64

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

Parameters:
runId The runId of the workflow execution to cancel.
Returns:
A reference to this updated object so that method calls can be chained together.
        this. = runId;
        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() );
        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()); 
        return hashCode;
    }
    
    @Override
    public boolean equals(Object obj) {
        if (this == objreturn true;
        if (obj == nullreturn false;
        if (obj instanceof RequestCancelWorkflowExecutionRequest == 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
        return true;
    }
    
    @Override
        
            return (RequestCancelWorkflowExecutionRequestsuper.clone();
    }
}
    
New to GrepCode? Check out our FAQ X