/*************************************************************************
* Copyright 2014 Eucalyptus Systems, Inc.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; version 3 of the License.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see http://www.gnu.org/licenses/.
*
* Please contact Eucalyptus Systems, Inc., 6755 Hollister Ave., Goleta
* CA 93117, USA or visit http://www.eucalyptus.com/licenses/ if you
* need additional information or have any questions.
*
* This file may incorporate work covered under the following copyright
* and permission notice:
* 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.eucalyptus.simpleworkflow.common.model;
import java.io.Serializable;
import javax.annotation.Nonnull;
import com.eucalyptus.auth.policy.annotation.PolicyAction;
/**
* Container for the parameters to the {@link com.amazonaws.services.simpleworkflow.AmazonSimpleWorkflow#respondActivityTaskCanceled(RespondActivityTaskCanceledRequest) RespondActivityTaskCanceled operation}.
* <p>
* Used by workers to tell the service that the ActivityTask identified
* by the <code>taskToken</code> was successfully canceled. Additional
* <code>details</code> can be optionally provided using the
* <code>details</code> argument.
* </p>
* <p>
* These <code>details</code> (if provided) appear in the
* <code>ActivityTaskCanceled</code> event added to the workflow history.
* </p>
* <p>
* <b>IMPORTANT:</b>Only use this operation if the canceled flag of a
* RecordActivityTaskHeartbeat request returns true and if the activity
* can be safely undone or abandoned.
* </p>
* <p>
* A task is considered open from the time that it is scheduled until it
* is closed. Therefore a task is reported as open while a worker is
* processing it. A task is closed after it has been specified in a call
* to RespondActivityTaskCompleted, RespondActivityTaskCanceled,
* RespondActivityTaskFailed, or the task has
* <a href="http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dg-basic.html#swf-dev-timeout-types"> timed out </a>
* .
* </p>
* <p>
* <b>Access Control</b>
* </p>
* <p>
* You can use IAM policies to control this action's access to Amazon SWF
* resources as follows:
* </p>
*
* <ul>
* <li>Use a <code>Resource</code> element with the domain name to limit
* the action to only specified domains.</li>
* <li>Use an <code>Action</code> element to allow or deny permission to
* call this action.</li>
* <li>You cannot use an IAM policy to constrain this action's
* parameters.</li>
*
* </ul>
* <p>
* 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
* <b>cause</b> parameter will be set to OPERATION_NOT_PERMITTED. For
* details and example IAM policies, see
* <a href="http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html"> Using IAM to Manage Access to Amazon SWF Workflows </a>
* .
* </p>
*
* @see com.amazonaws.services.simpleworkflow.AmazonSimpleWorkflow#respondActivityTaskCanceled(RespondActivityTaskCanceledRequest)
*/
@PolicyAction( vendor = "swf", action = "respondactivitytaskcanceled" )
public class RespondActivityTaskCanceledRequest extends SimpleWorkflowMessage implements Serializable {
/**
* The <code>taskToken</code> of the <a>ActivityTask</a>.
* <important><code>taskToken</code> is generated by the service and
* should be treated as an opaque value. If the task is passed to another
* process, its <code>taskToken</code> must also be passed. This enables
* it to provide its progress and respond with results.</important>
* <p>
* <b>Constraints:</b><br/>
* <b>Length: </b>1 - 1024<br/>
*/
@Nonnull
@FieldRegex( FieldRegexValue.STRING_1024 )
private String taskToken;
/**
* <i>Optional.</i> Information about the cancellation.
* <p>
* <b>Constraints:</b><br/>
* <b>Length: </b>0 - 32768<br/>
*/
@FieldRegex( FieldRegexValue.OPT_STRING_32768 )
private String details;
/**
* The <code>taskToken</code> of the <a>ActivityTask</a>.
* <important><code>taskToken</code> is generated by the service and
* should be treated as an opaque value. If the task is passed to another
* process, its <code>taskToken</code> must also be passed. This enables
* it to provide its progress and respond with results.</important>
* <p>
* <b>Constraints:</b><br/>
* <b>Length: </b>1 - 1024<br/>
*
* @return The <code>taskToken</code> of the <a>ActivityTask</a>.
* <important><code>taskToken</code> is generated by the service and
* should be treated as an opaque value. If the task is passed to another
* process, its <code>taskToken</code> must also be passed. This enables
* it to provide its progress and respond with results.</important>
*/
public String getTaskToken() {
return taskToken;
}
/**
* The <code>taskToken</code> of the <a>ActivityTask</a>.
* <important><code>taskToken</code> is generated by the service and
* should be treated as an opaque value. If the task is passed to another
* process, its <code>taskToken</code> must also be passed. This enables
* it to provide its progress and respond with results.</important>
* <p>
* <b>Constraints:</b><br/>
* <b>Length: </b>1 - 1024<br/>
*
* @param taskToken The <code>taskToken</code> of the <a>ActivityTask</a>.
* <important><code>taskToken</code> is generated by the service and
* should be treated as an opaque value. If the task is passed to another
* process, its <code>taskToken</code> must also be passed. This enables
* it to provide its progress and respond with results.</important>
*/
public void setTaskToken(String taskToken) {
this.taskToken = taskToken;
}
/**
* The <code>taskToken</code> of the <a>ActivityTask</a>.
* <important><code>taskToken</code> is generated by the service and
* should be treated as an opaque value. If the task is passed to another
* process, its <code>taskToken</code> must also be passed. This enables
* it to provide its progress and respond with results.</important>
* <p>
* Returns a reference to this object so that method calls can be chained together.
* <p>
* <b>Constraints:</b><br/>
* <b>Length: </b>1 - 1024<br/>
*
* @param taskToken The <code>taskToken</code> of the <a>ActivityTask</a>.
* <important><code>taskToken</code> is generated by the service and
* should be treated as an opaque value. If the task is passed to another
* process, its <code>taskToken</code> must also be passed. This enables
* it to provide its progress and respond with results.</important>
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public RespondActivityTaskCanceledRequest withTaskToken(String taskToken) {
this.taskToken = taskToken;
return this;
}
/**
* <i>Optional.</i> Information about the cancellation.
* <p>
* <b>Constraints:</b><br/>
* <b>Length: </b>0 - 32768<br/>
*
* @return <i>Optional.</i> Information about the cancellation.
*/
public String getDetails() {
return details;
}
/**
* <i>Optional.</i> Information about the cancellation.
* <p>
* <b>Constraints:</b><br/>
* <b>Length: </b>0 - 32768<br/>
*
* @param details <i>Optional.</i> Information about the cancellation.
*/
public void setDetails(String details) {
this.details = details;
}
/**
* <i>Optional.</i> Information about the cancellation.
* <p>
* Returns a reference to this object so that method calls can be chained together.
* <p>
* <b>Constraints:</b><br/>
* <b>Length: </b>0 - 32768<br/>
*
* @param details <i>Optional.</i> Information about the cancellation.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public RespondActivityTaskCanceledRequest withDetails(String details) {
this.details = details;
return this;
}
/**
* Returns a string representation of this object; useful for testing and
* debugging.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getTaskToken() != null) sb.append("TaskToken: " + getTaskToken() + ",");
if (getDetails() != null) sb.append("Details: " + getDetails() );
sb.append("}");
return sb.toString();
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getTaskToken() == null) ? 0 : getTaskToken().hashCode());
hashCode = prime * hashCode + ((getDetails() == null) ? 0 : getDetails().hashCode());
return hashCode;
}
@Override
public boolean equals(Object obj) {
if (this == obj) return true;
if (obj == null) return false;
if (obj instanceof RespondActivityTaskCanceledRequest == false) return false;
RespondActivityTaskCanceledRequest other = (RespondActivityTaskCanceledRequest)obj;
if (other.getTaskToken() == null ^ this.getTaskToken() == null) return false;
if (other.getTaskToken() != null && other.getTaskToken().equals(this.getTaskToken()) == false) return false;
if (other.getDetails() == null ^ this.getDetails() == null) return false;
if (other.getDetails() != null && other.getDetails().equals(this.getDetails()) == false) return false;
return true;
}
}