com.amazonaws.services.simpleworkflow.model.RespondActivityTaskCompletedRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk Show documentation
/*
* Copyright 2010-2014 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;
import java.io.Serializable;
import com.amazonaws.AmazonWebServiceRequest;
/**
* Container for the parameters to the {@link com.amazonaws.services.simpleworkflow.AmazonSimpleWorkflow#respondActivityTaskCompleted(RespondActivityTaskCompletedRequest) RespondActivityTaskCompleted operation}.
*
* Used by workers to tell the service that the ActivityTask identified
* by the taskToken completed successfully with a
* result (if provided). The result appears in
* the ActivityTaskCompleted event in the workflow history.
*
*
* IMPORTANT: If the requested task does not complete
* successfully, use RespondActivityTaskFailed instead. If the worker
* finds that the task is canceled through the canceled flag returned by
* RecordActivityTaskHeartbeat, it should cancel the task, clean up and
* then call RespondActivityTaskCanceled.
*
*
* 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
* timed out
* .
*
*
* 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
* .
*
*
* @see com.amazonaws.services.simpleworkflow.AmazonSimpleWorkflow#respondActivityTaskCompleted(RespondActivityTaskCompletedRequest)
*/
public class RespondActivityTaskCompletedRequest extends AmazonWebServiceRequest implements Serializable {
/**
* The taskToken of the ActivityTask. The
* taskToken is generated by the service and should be
* treated as an opaque value. If the task is passed to another process,
* its taskToken must also be passed. This enables it to
* provide its progress and respond with results.
*
* Constraints:
* Length: 1 - 1024
*/
private String taskToken;
/**
* The result of the activity task. It is a free form string that is
* implementation specific.
*
* Constraints:
* Length: 0 - 32768
*/
private String result;
/**
* The taskToken of the ActivityTask. The
* taskToken is generated by the service and should be
* treated as an opaque value. If the task is passed to another process,
* its taskToken must also be passed. This enables it to
* provide its progress and respond with results.
*
* Constraints:
* Length: 1 - 1024
*
* @return The taskToken of the ActivityTask. The
* taskToken is generated by the service and should be
* treated as an opaque value. If the task is passed to another process,
* its taskToken must also be passed. This enables it to
* provide its progress and respond with results.
*/
public String getTaskToken() {
return taskToken;
}
/**
* The taskToken of the ActivityTask. The
* taskToken is generated by the service and should be
* treated as an opaque value. If the task is passed to another process,
* its taskToken must also be passed. This enables it to
* provide its progress and respond with results.
*
* Constraints:
* Length: 1 - 1024
*
* @param taskToken The taskToken of the ActivityTask. The
* taskToken is generated by the service and should be
* treated as an opaque value. If the task is passed to another process,
* its taskToken must also be passed. This enables it to
* provide its progress and respond with results.
*/
public void setTaskToken(String taskToken) {
this.taskToken = taskToken;
}
/**
* The taskToken of the ActivityTask. The
* taskToken is generated by the service and should be
* treated as an opaque value. If the task is passed to another process,
* its taskToken must also be passed. This enables it to
* provide its progress and respond with results.
*
* Returns a reference to this object so that method calls can be chained together.
*
* Constraints:
* Length: 1 - 1024
*
* @param taskToken The taskToken of the ActivityTask. The
* taskToken is generated by the service and should be
* treated as an opaque value. If the task is passed to another process,
* its taskToken must also be passed. This enables it to
* provide its progress and respond with results.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public RespondActivityTaskCompletedRequest withTaskToken(String taskToken) {
this.taskToken = taskToken;
return this;
}
/**
* The result of the activity task. It is a free form string that is
* implementation specific.
*
* Constraints:
* Length: 0 - 32768
*
* @return The result of the activity task. It is a free form string that is
* implementation specific.
*/
public String getResult() {
return result;
}
/**
* The result of the activity task. It is a free form string that is
* implementation specific.
*
* Constraints:
* Length: 0 - 32768
*
* @param result The result of the activity task. It is a free form string that is
* implementation specific.
*/
public void setResult(String result) {
this.result = result;
}
/**
* The result of the activity task. It is a free form string that is
* implementation specific.
*
* Returns a reference to this object so that method calls can be chained together.
*
* Constraints:
* Length: 0 - 32768
*
* @param result The result of the activity task. It is a free form string that is
* implementation specific.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public RespondActivityTaskCompletedRequest withResult(String result) {
this.result = result;
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 (getResult() != null) sb.append("Result: " + getResult() );
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 + ((getResult() == null) ? 0 : getResult().hashCode());
return hashCode;
}
@Override
public boolean equals(Object obj) {
if (this == obj) return true;
if (obj == null) return false;
if (obj instanceof RespondActivityTaskCompletedRequest == false) return false;
RespondActivityTaskCompletedRequest other = (RespondActivityTaskCompletedRequest)obj;
if (other.getTaskToken() == null ^ this.getTaskToken() == null) return false;
if (other.getTaskToken() != null && other.getTaskToken().equals(this.getTaskToken()) == false) return false;
if (other.getResult() == null ^ this.getResult() == null) return false;
if (other.getResult() != null && other.getResult().equals(this.getResult()) == false) return false;
return true;
}
}