/*************************************************************************
* 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#pollForDecisionTask(PollForDecisionTaskRequest) PollForDecisionTask operation}.
* <p>
* Used by deciders to get a DecisionTask from the specified decision
* <code>taskList</code> . A decision task may be returned for any open
* workflow execution that is using the specified task list. The task
* includes a paginated view of the history of the workflow execution.
* The decider should use the workflow type and the history to determine
* how to properly handle the task.
* </p>
* <p>
* This action initiates a long poll, where the service holds the HTTP
* connection open and responds as soon a task becomes available. If no
* decision task is available in the specified task list before the
* timeout of 60 seconds expires, an empty result is returned. An empty
* result, in this context, means that a DecisionTask is returned, but
* that the value of <code>taskToken</code> is an empty string.
* </p>
* <p>
* <b>IMPORTANT:</b>Deciders should set their client-side socket timeout
* to at least 70 seconds (10 seconds higher than the timeout).
* </p>
* <p>
* <b>IMPORTANT:</b>Because the number of workflow history events for a
* single workflow execution might be very large, the result returned
* might be split up across a number of pages. To retrieve subsequent
* pages, make additional calls to PollForDecisionTask using the
* nextPageToken returned by the initial call. Note that you do not call
* GetWorkflowExecutionHistory with this nextPageToken. Instead, call
* PollForDecisionTask again.
* </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>Constrain the <code>taskList.name</code> parameter by using a
* <b>Condition</b> element with the <code>swf:taskList.name</code> key
* to allow the action to access only certain task lists.</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#pollForDecisionTask(PollForDecisionTaskRequest)
*/
@PolicyAction( vendor = "swf", action = "pollfordecisiontask" )
public class PollForDecisionTaskRequest extends SimpleWorkflowMessage implements Serializable {
/**
* The name of the domain containing the task lists to poll.
* <p>
* <b>Constraints:</b><br/>
* <b>Length: </b>1 - 256<br/>
*/
@Nonnull
@FieldRegex( FieldRegexValue.NAME_256 )
private String domain;
/**
* Specifies the task list to poll for decision tasks. <p>The specified
* string must not start or end with whitespace. It must not contain a
* <code>:</code> (colon), <code>/</code> (slash), <code>|</code>
* (vertical bar), or any control characters (\u0000-\u001f | \u007f -
* \u009f). Also, it must not contain the literal string "arn".
*/
@Nonnull
private TaskList taskList;
/**
* Identity of the decider making the request, which is recorded in the
* DecisionTaskStarted event in the workflow history. This enables
* diagnostic tracing when problems arise. The form of this identity is
* user defined.
* <p>
* <b>Constraints:</b><br/>
* <b>Length: </b>0 - 256<br/>
*/
@FieldRegex( FieldRegexValue.OPT_STRING_256 )
private String identity;
/**
* If a <code>NextPageToken</code> was returned by a previous call, there
* are more results available. To retrieve the next page of results, make
* the call again using the returned token in <code>nextPageToken</code>.
* Keep all other arguments unchanged. <p>The configured
* <code>maximumPageSize</code> determines how many results can be
* returned in a single call. <note>The <code>nextPageToken</code>
* returned by this action cannot be used with
* <a>GetWorkflowExecutionHistory</a> to get the next page. You must call
* <a>PollForDecisionTask</a> again (with the <code>nextPageToken</code>)
* to retrieve the next page of history records. Calling
* <a>PollForDecisionTask</a> with a <code>nextPageToken</code> will not
* return a new decision task.</note>.
* <p>
* <b>Constraints:</b><br/>
* <b>Length: </b>0 - 2048<br/>
*/
@FieldRegex( FieldRegexValue.OPT_STRING_2048 )
private String nextPageToken;
/**
* The maximum number of results that will be returned per call.
* <code>nextPageToken</code> can be used to obtain futher pages of
* results. The default is 1000, which is the maximum allowed page size.
* You can, however, specify a page size <i>smaller</i> than the maximum.
* <p>This is an upper limit only; the actual number of results returned
* per call may be fewer than the specified maximum.
* <p>
* <b>Constraints:</b><br/>
* <b>Range: </b>0 - 1000<br/>
*/
@FieldRange( max = 1000 )
private Integer maximumPageSize;
/**
* When set to <code>true</code>, returns the events in reverse order. By
* default the results are returned in ascending order of the
* <code>eventTimestamp</code> of the events.
*/
private Boolean reverseOrder;
/**
* The name of the domain containing the task lists to poll.
* <p>
* <b>Constraints:</b><br/>
* <b>Length: </b>1 - 256<br/>
*
* @return The name of the domain containing the task lists to poll.
*/
public String getDomain() {
return domain;
}
/**
* The name of the domain containing the task lists to poll.
* <p>
* <b>Constraints:</b><br/>
* <b>Length: </b>1 - 256<br/>
*
* @param domain The name of the domain containing the task lists to poll.
*/
public void setDomain(String domain) {
this.domain = domain;
}
/**
* The name of the domain containing the task lists to poll.
* <p>
* Returns a reference to this object so that method calls can be chained together.
* <p>
* <b>Constraints:</b><br/>
* <b>Length: </b>1 - 256<br/>
*
* @param domain The name of the domain containing the task lists to poll.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public PollForDecisionTaskRequest withDomain(String domain) {
this.domain = domain;
return this;
}
/**
* Specifies the task list to poll for decision tasks. <p>The specified
* string must not start or end with whitespace. It must not contain a
* <code>:</code> (colon), <code>/</code> (slash), <code>|</code>
* (vertical bar), or any control characters (\u0000-\u001f | \u007f -
* \u009f). Also, it must not contain the literal string "arn".
*
* @return Specifies the task list to poll for decision tasks. <p>The specified
* string must not start or end with whitespace. It must not contain a
* <code>:</code> (colon), <code>/</code> (slash), <code>|</code>
* (vertical bar), or any control characters (\u0000-\u001f | \u007f -
* \u009f). Also, it must not contain the literal string "arn".
*/
public TaskList getTaskList() {
return taskList;
}
/**
* Specifies the task list to poll for decision tasks. <p>The specified
* string must not start or end with whitespace. It must not contain a
* <code>:</code> (colon), <code>/</code> (slash), <code>|</code>
* (vertical bar), or any control characters (\u0000-\u001f | \u007f -
* \u009f). Also, it must not contain the literal string "arn".
*
* @param taskList Specifies the task list to poll for decision tasks. <p>The specified
* string must not start or end with whitespace. It must not contain a
* <code>:</code> (colon), <code>/</code> (slash), <code>|</code>
* (vertical bar), or any control characters (\u0000-\u001f | \u007f -
* \u009f). Also, it must not contain the literal string "arn".
*/
public void setTaskList(TaskList taskList) {
this.taskList = taskList;
}
/**
* Specifies the task list to poll for decision tasks. <p>The specified
* string must not start or end with whitespace. It must not contain a
* <code>:</code> (colon), <code>/</code> (slash), <code>|</code>
* (vertical bar), or any control characters (\u0000-\u001f | \u007f -
* \u009f). Also, it must not contain the literal string "arn".
* <p>
* Returns a reference to this object so that method calls can be chained together.
*
* @param taskList Specifies the task list to poll for decision tasks. <p>The specified
* string must not start or end with whitespace. It must not contain a
* <code>:</code> (colon), <code>/</code> (slash), <code>|</code>
* (vertical bar), or any control characters (\u0000-\u001f | \u007f -
* \u009f). Also, it must not contain the literal string "arn".
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public PollForDecisionTaskRequest withTaskList(TaskList taskList) {
this.taskList = taskList;
return this;
}
/**
* Identity of the decider making the request, which is recorded in the
* DecisionTaskStarted event in the workflow history. This enables
* diagnostic tracing when problems arise. The form of this identity is
* user defined.
* <p>
* <b>Constraints:</b><br/>
* <b>Length: </b>0 - 256<br/>
*
* @return Identity of the decider making the request, which is recorded in the
* DecisionTaskStarted event in the workflow history. This enables
* diagnostic tracing when problems arise. The form of this identity is
* user defined.
*/
public String getIdentity() {
return identity;
}
/**
* Identity of the decider making the request, which is recorded in the
* DecisionTaskStarted event in the workflow history. This enables
* diagnostic tracing when problems arise. The form of this identity is
* user defined.
* <p>
* <b>Constraints:</b><br/>
* <b>Length: </b>0 - 256<br/>
*
* @param identity Identity of the decider making the request, which is recorded in the
* DecisionTaskStarted event in the workflow history. This enables
* diagnostic tracing when problems arise. The form of this identity is
* user defined.
*/
public void setIdentity(String identity) {
this.identity = identity;
}
/**
* Identity of the decider making the request, which is recorded in the
* DecisionTaskStarted event in the workflow history. This enables
* diagnostic tracing when problems arise. The form of this identity is
* user defined.
* <p>
* Returns a reference to this object so that method calls can be chained together.
* <p>
* <b>Constraints:</b><br/>
* <b>Length: </b>0 - 256<br/>
*
* @param identity Identity of the decider making the request, which is recorded in the
* DecisionTaskStarted event in the workflow history. This enables
* diagnostic tracing when problems arise. The form of this identity is
* user defined.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public PollForDecisionTaskRequest withIdentity(String identity) {
this.identity = identity;
return this;
}
/**
* If a <code>NextPageToken</code> was returned by a previous call, there
* are more results available. To retrieve the next page of results, make
* the call again using the returned token in <code>nextPageToken</code>.
* Keep all other arguments unchanged. <p>The configured
* <code>maximumPageSize</code> determines how many results can be
* returned in a single call. <note>The <code>nextPageToken</code>
* returned by this action cannot be used with
* <a>GetWorkflowExecutionHistory</a> to get the next page. You must call
* <a>PollForDecisionTask</a> again (with the <code>nextPageToken</code>)
* to retrieve the next page of history records. Calling
* <a>PollForDecisionTask</a> with a <code>nextPageToken</code> will not
* return a new decision task.</note>.
* <p>
* <b>Constraints:</b><br/>
* <b>Length: </b>0 - 2048<br/>
*
* @return If a <code>NextPageToken</code> was returned by a previous call, there
* are more results available. To retrieve the next page of results, make
* the call again using the returned token in <code>nextPageToken</code>.
* Keep all other arguments unchanged. <p>The configured
* <code>maximumPageSize</code> determines how many results can be
* returned in a single call. <note>The <code>nextPageToken</code>
* returned by this action cannot be used with
* <a>GetWorkflowExecutionHistory</a> to get the next page. You must call
* <a>PollForDecisionTask</a> again (with the <code>nextPageToken</code>)
* to retrieve the next page of history records. Calling
* <a>PollForDecisionTask</a> with a <code>nextPageToken</code> will not
* return a new decision task.</note>.
*/
public String getNextPageToken() {
return nextPageToken;
}
/**
* If a <code>NextPageToken</code> was returned by a previous call, there
* are more results available. To retrieve the next page of results, make
* the call again using the returned token in <code>nextPageToken</code>.
* Keep all other arguments unchanged. <p>The configured
* <code>maximumPageSize</code> determines how many results can be
* returned in a single call. <note>The <code>nextPageToken</code>
* returned by this action cannot be used with
* <a>GetWorkflowExecutionHistory</a> to get the next page. You must call
* <a>PollForDecisionTask</a> again (with the <code>nextPageToken</code>)
* to retrieve the next page of history records. Calling
* <a>PollForDecisionTask</a> with a <code>nextPageToken</code> will not
* return a new decision task.</note>.
* <p>
* <b>Constraints:</b><br/>
* <b>Length: </b>0 - 2048<br/>
*
* @param nextPageToken If a <code>NextPageToken</code> was returned by a previous call, there
* are more results available. To retrieve the next page of results, make
* the call again using the returned token in <code>nextPageToken</code>.
* Keep all other arguments unchanged. <p>The configured
* <code>maximumPageSize</code> determines how many results can be
* returned in a single call. <note>The <code>nextPageToken</code>
* returned by this action cannot be used with
* <a>GetWorkflowExecutionHistory</a> to get the next page. You must call
* <a>PollForDecisionTask</a> again (with the <code>nextPageToken</code>)
* to retrieve the next page of history records. Calling
* <a>PollForDecisionTask</a> with a <code>nextPageToken</code> will not
* return a new decision task.</note>.
*/
public void setNextPageToken(String nextPageToken) {
this.nextPageToken = nextPageToken;
}
/**
* If a <code>NextPageToken</code> was returned by a previous call, there
* are more results available. To retrieve the next page of results, make
* the call again using the returned token in <code>nextPageToken</code>.
* Keep all other arguments unchanged. <p>The configured
* <code>maximumPageSize</code> determines how many results can be
* returned in a single call. <note>The <code>nextPageToken</code>
* returned by this action cannot be used with
* <a>GetWorkflowExecutionHistory</a> to get the next page. You must call
* <a>PollForDecisionTask</a> again (with the <code>nextPageToken</code>)
* to retrieve the next page of history records. Calling
* <a>PollForDecisionTask</a> with a <code>nextPageToken</code> will not
* return a new decision task.</note>.
* <p>
* Returns a reference to this object so that method calls can be chained together.
* <p>
* <b>Constraints:</b><br/>
* <b>Length: </b>0 - 2048<br/>
*
* @param nextPageToken If a <code>NextPageToken</code> was returned by a previous call, there
* are more results available. To retrieve the next page of results, make
* the call again using the returned token in <code>nextPageToken</code>.
* Keep all other arguments unchanged. <p>The configured
* <code>maximumPageSize</code> determines how many results can be
* returned in a single call. <note>The <code>nextPageToken</code>
* returned by this action cannot be used with
* <a>GetWorkflowExecutionHistory</a> to get the next page. You must call
* <a>PollForDecisionTask</a> again (with the <code>nextPageToken</code>)
* to retrieve the next page of history records. Calling
* <a>PollForDecisionTask</a> with a <code>nextPageToken</code> will not
* return a new decision task.</note>.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public PollForDecisionTaskRequest withNextPageToken(String nextPageToken) {
this.nextPageToken = nextPageToken;
return this;
}
/**
* The maximum number of results that will be returned per call.
* <code>nextPageToken</code> can be used to obtain futher pages of
* results. The default is 1000, which is the maximum allowed page size.
* You can, however, specify a page size <i>smaller</i> than the maximum.
* <p>This is an upper limit only; the actual number of results returned
* per call may be fewer than the specified maximum.
* <p>
* <b>Constraints:</b><br/>
* <b>Range: </b>0 - 1000<br/>
*
* @return The maximum number of results that will be returned per call.
* <code>nextPageToken</code> can be used to obtain futher pages of
* results. The default is 1000, which is the maximum allowed page size.
* You can, however, specify a page size <i>smaller</i> than the maximum.
* <p>This is an upper limit only; the actual number of results returned
* per call may be fewer than the specified maximum.
*/
public Integer getMaximumPageSize() {
return maximumPageSize;
}
/**
* The maximum number of results that will be returned per call.
* <code>nextPageToken</code> can be used to obtain futher pages of
* results. The default is 1000, which is the maximum allowed page size.
* You can, however, specify a page size <i>smaller</i> than the maximum.
* <p>This is an upper limit only; the actual number of results returned
* per call may be fewer than the specified maximum.
* <p>
* <b>Constraints:</b><br/>
* <b>Range: </b>0 - 1000<br/>
*
* @param maximumPageSize The maximum number of results that will be returned per call.
* <code>nextPageToken</code> can be used to obtain futher pages of
* results. The default is 1000, which is the maximum allowed page size.
* You can, however, specify a page size <i>smaller</i> than the maximum.
* <p>This is an upper limit only; the actual number of results returned
* per call may be fewer than the specified maximum.
*/
public void setMaximumPageSize(Integer maximumPageSize) {
this.maximumPageSize = maximumPageSize;
}
/**
* The maximum number of results that will be returned per call.
* <code>nextPageToken</code> can be used to obtain futher pages of
* results. The default is 1000, which is the maximum allowed page size.
* You can, however, specify a page size <i>smaller</i> than the maximum.
* <p>This is an upper limit only; the actual number of results returned
* per call may be fewer than the specified maximum.
* <p>
* Returns a reference to this object so that method calls can be chained together.
* <p>
* <b>Constraints:</b><br/>
* <b>Range: </b>0 - 1000<br/>
*
* @param maximumPageSize The maximum number of results that will be returned per call.
* <code>nextPageToken</code> can be used to obtain futher pages of
* results. The default is 1000, which is the maximum allowed page size.
* You can, however, specify a page size <i>smaller</i> than the maximum.
* <p>This is an upper limit only; the actual number of results returned
* per call may be fewer than the specified maximum.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public PollForDecisionTaskRequest withMaximumPageSize(Integer maximumPageSize) {
this.maximumPageSize = maximumPageSize;
return this;
}
/**
* When set to <code>true</code>, returns the events in reverse order. By
* default the results are returned in ascending order of the
* <code>eventTimestamp</code> of the events.
*
* @return When set to <code>true</code>, returns the events in reverse order. By
* default the results are returned in ascending order of the
* <code>eventTimestamp</code> of the events.
*/
public Boolean isReverseOrder() {
return reverseOrder;
}
/**
* When set to <code>true</code>, returns the events in reverse order. By
* default the results are returned in ascending order of the
* <code>eventTimestamp</code> of the events.
*
* @param reverseOrder When set to <code>true</code>, returns the events in reverse order. By
* default the results are returned in ascending order of the
* <code>eventTimestamp</code> of the events.
*/
public void setReverseOrder(Boolean reverseOrder) {
this.reverseOrder = reverseOrder;
}
/**
* When set to <code>true</code>, returns the events in reverse order. By
* default the results are returned in ascending order of the
* <code>eventTimestamp</code> of the events.
* <p>
* Returns a reference to this object so that method calls can be chained together.
*
* @param reverseOrder When set to <code>true</code>, returns the events in reverse order. By
* default the results are returned in ascending order of the
* <code>eventTimestamp</code> of the events.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public PollForDecisionTaskRequest withReverseOrder(Boolean reverseOrder) {
this.reverseOrder = reverseOrder;
return this;
}
/**
* When set to <code>true</code>, returns the events in reverse order. By
* default the results are returned in ascending order of the
* <code>eventTimestamp</code> of the events.
*
* @return When set to <code>true</code>, returns the events in reverse order. By
* default the results are returned in ascending order of the
* <code>eventTimestamp</code> of the events.
*/
public Boolean getReverseOrder() {
return reverseOrder;
}
/**
* 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 (getDomain() != null) sb.append("Domain: " + getDomain() + ",");
if (getTaskList() != null) sb.append("TaskList: " + getTaskList() + ",");
if (getIdentity() != null) sb.append("Identity: " + getIdentity() + ",");
if (getNextPageToken() != null) sb.append("NextPageToken: " + getNextPageToken() + ",");
if (getMaximumPageSize() != null) sb.append("MaximumPageSize: " + getMaximumPageSize() + ",");
if (isReverseOrder() != null) sb.append("ReverseOrder: " + isReverseOrder() );
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 + ((getTaskList() == null) ? 0 : getTaskList().hashCode());
hashCode = prime * hashCode + ((getIdentity() == null) ? 0 : getIdentity().hashCode());
hashCode = prime * hashCode + ((getNextPageToken() == null) ? 0 : getNextPageToken().hashCode());
hashCode = prime * hashCode + ((getMaximumPageSize() == null) ? 0 : getMaximumPageSize().hashCode());
hashCode = prime * hashCode + ((isReverseOrder() == null) ? 0 : isReverseOrder().hashCode());
return hashCode;
}
@Override
public boolean equals(Object obj) {
if (this == obj) return true;
if (obj == null) return false;
if (obj instanceof PollForDecisionTaskRequest == false) return false;
PollForDecisionTaskRequest other = (PollForDecisionTaskRequest)obj;
if (other.getDomain() == null ^ this.getDomain() == null) return false;
if (other.getDomain() != null && other.getDomain().equals(this.getDomain()) == false) return false;
if (other.getTaskList() == null ^ this.getTaskList() == null) return false;
if (other.getTaskList() != null && other.getTaskList().equals(this.getTaskList()) == false) return false;
if (other.getIdentity() == null ^ this.getIdentity() == null) return false;
if (other.getIdentity() != null && other.getIdentity().equals(this.getIdentity()) == false) return false;
if (other.getNextPageToken() == null ^ this.getNextPageToken() == null) return false;
if (other.getNextPageToken() != null && other.getNextPageToken().equals(this.getNextPageToken()) == false) return false;
if (other.getMaximumPageSize() == null ^ this.getMaximumPageSize() == null) return false;
if (other.getMaximumPageSize() != null && other.getMaximumPageSize().equals(this.getMaximumPageSize()) == false) return false;
if (other.isReverseOrder() == null ^ this.isReverseOrder() == null) return false;
if (other.isReverseOrder() != null && other.isReverseOrder().equals(this.isReverseOrder()) == false) return false;
return true;
}
}