com.amazonaws.services.simpleworkflow.model.PollForDecisionTaskRequest 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#pollForDecisionTask(PollForDecisionTaskRequest) PollForDecisionTask operation}.
*
* Used by deciders to get a DecisionTask from the specified decision
* taskList .
* 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.
*
*
* 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 taskToken is an empty string.
*
*
* IMPORTANT: Deciders should set their client side socket timeout
* to at least 70 seconds (10 seconds higher than the timeout).
*
*
* IMPORTANT: 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.
*
*
* 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.
* - Use a Condition element with the
*
swf:taskList.name key to allow the action to access only
* certain task lists.
*
*
*
* 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#pollForDecisionTask(PollForDecisionTaskRequest)
*/
public class PollForDecisionTaskRequest extends AmazonWebServiceRequest implements Serializable {
/**
* The name of the domain containing the task lists to poll.
*
* Constraints:
* Length: 1 - 256
*/
private String domain;
/**
* Specifies the task list to poll for decision tasks.
The specified
* string must not start or end with whitespace. It must not contain a
* : (colon), / (slash), |
* (vertical bar), or any control characters (\u0000-\u001f | \u007f -
* \u009f). Also, it must not contain the literal string "arn".
*/
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.
*
* Constraints:
* Length: 0 - 256
*/
private String identity;
/**
* If on a previous call to this method a NextPageToken was
* returned, the results are being paginated. To get the next page of
* results, repeat the call with the returned token and all other
* arguments unchanged. The nextPageToken returned by
* this action cannot be used with GetWorkflowExecutionHistory to
* get the next page. You must call PollForDecisionTask again
* (with the nextPageToken) to retrieve the next page of
* history records. Calling PollForDecisionTask with a
* nextPageToken will not return a new decision
* task. .
*
* Constraints:
* Length: 0 - 2048
*/
private String nextPageToken;
/**
* The maximum number of history events returned in each page. The
* default is 100, but the caller can override this value to a page size
* smaller than the default. You cannot specify a page size
* greater than 100. Note that the number of events may be less than the
* maxiumum page size, in which case, the returned page will have fewer
* results than the maximumPageSize specified.
*
* Constraints:
* Range: 0 - 1000
*/
private Integer maximumPageSize;
/**
* When set to true, returns the events in reverse order. By
* default the results are returned in ascending order of the
* eventTimestamp of the events.
*/
private Boolean reverseOrder;
/**
* The name of the domain containing the task lists to poll.
*
* Constraints:
* Length: 1 - 256
*
* @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.
*
* Constraints:
* Length: 1 - 256
*
* @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.
*
* Returns a reference to this object so that method calls can be chained together.
*
* Constraints:
* Length: 1 - 256
*
* @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.
The specified
* string must not start or end with whitespace. It must not contain a
* : (colon), / (slash), |
* (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.
The specified
* string must not start or end with whitespace. It must not contain a
* : (colon), / (slash), |
* (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.
The specified
* string must not start or end with whitespace. It must not contain a
* : (colon), / (slash), |
* (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.
The specified
* string must not start or end with whitespace. It must not contain a
* : (colon), / (slash), |
* (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.
The specified
* string must not start or end with whitespace. It must not contain a
* : (colon), / (slash), |
* (vertical bar), or any control characters (\u0000-\u001f | \u007f -
* \u009f). Also, it must not contain the literal string "arn".
*
* 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.
The specified
* string must not start or end with whitespace. It must not contain a
* : (colon), / (slash), |
* (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.
*
* Constraints:
* Length: 0 - 256
*
* @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.
*
* Constraints:
* Length: 0 - 256
*
* @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.
*
* Returns a reference to this object so that method calls can be chained together.
*
* Constraints:
* Length: 0 - 256
*
* @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 on a previous call to this method a NextPageToken was
* returned, the results are being paginated. To get the next page of
* results, repeat the call with the returned token and all other
* arguments unchanged. The nextPageToken returned by
* this action cannot be used with GetWorkflowExecutionHistory to
* get the next page. You must call PollForDecisionTask again
* (with the nextPageToken) to retrieve the next page of
* history records. Calling PollForDecisionTask with a
* nextPageToken will not return a new decision
* task. .
*
* Constraints:
* Length: 0 - 2048
*
* @return If on a previous call to this method a NextPageToken was
* returned, the results are being paginated. To get the next page of
* results, repeat the call with the returned token and all other
* arguments unchanged. The nextPageToken returned by
* this action cannot be used with GetWorkflowExecutionHistory to
* get the next page. You must call PollForDecisionTask again
* (with the nextPageToken) to retrieve the next page of
* history records. Calling PollForDecisionTask with a
* nextPageToken will not return a new decision
* task. .
*/
public String getNextPageToken() {
return nextPageToken;
}
/**
* If on a previous call to this method a NextPageToken was
* returned, the results are being paginated. To get the next page of
* results, repeat the call with the returned token and all other
* arguments unchanged. The nextPageToken returned by
* this action cannot be used with GetWorkflowExecutionHistory to
* get the next page. You must call PollForDecisionTask again
* (with the nextPageToken) to retrieve the next page of
* history records. Calling PollForDecisionTask with a
* nextPageToken will not return a new decision
* task. .
*
* Constraints:
* Length: 0 - 2048
*
* @param nextPageToken If on a previous call to this method a NextPageToken was
* returned, the results are being paginated. To get the next page of
* results, repeat the call with the returned token and all other
* arguments unchanged. The nextPageToken returned by
* this action cannot be used with GetWorkflowExecutionHistory to
* get the next page. You must call PollForDecisionTask again
* (with the nextPageToken) to retrieve the next page of
* history records. Calling PollForDecisionTask with a
* nextPageToken will not return a new decision
* task. .
*/
public void setNextPageToken(String nextPageToken) {
this.nextPageToken = nextPageToken;
}
/**
* If on a previous call to this method a NextPageToken was
* returned, the results are being paginated. To get the next page of
* results, repeat the call with the returned token and all other
* arguments unchanged. The nextPageToken returned by
* this action cannot be used with GetWorkflowExecutionHistory to
* get the next page. You must call PollForDecisionTask again
* (with the nextPageToken) to retrieve the next page of
* history records. Calling PollForDecisionTask with a
* nextPageToken will not return a new decision
* task. .
*
* Returns a reference to this object so that method calls can be chained together.
*
* Constraints:
* Length: 0 - 2048
*
* @param nextPageToken If on a previous call to this method a NextPageToken was
* returned, the results are being paginated. To get the next page of
* results, repeat the call with the returned token and all other
* arguments unchanged. The nextPageToken returned by
* this action cannot be used with GetWorkflowExecutionHistory to
* get the next page. You must call PollForDecisionTask again
* (with the nextPageToken) to retrieve the next page of
* history records. Calling PollForDecisionTask with a
* nextPageToken will not return a new decision
* task. .
*
* @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 history events returned in each page. The
* default is 100, but the caller can override this value to a page size
* smaller than the default. You cannot specify a page size
* greater than 100. Note that the number of events may be less than the
* maxiumum page size, in which case, the returned page will have fewer
* results than the maximumPageSize specified.
*
* Constraints:
* Range: 0 - 1000
*
* @return The maximum number of history events returned in each page. The
* default is 100, but the caller can override this value to a page size
* smaller than the default. You cannot specify a page size
* greater than 100. Note that the number of events may be less than the
* maxiumum page size, in which case, the returned page will have fewer
* results than the maximumPageSize specified.
*/
public Integer getMaximumPageSize() {
return maximumPageSize;
}
/**
* The maximum number of history events returned in each page. The
* default is 100, but the caller can override this value to a page size
* smaller than the default. You cannot specify a page size
* greater than 100. Note that the number of events may be less than the
* maxiumum page size, in which case, the returned page will have fewer
* results than the maximumPageSize specified.
*
* Constraints:
* Range: 0 - 1000
*
* @param maximumPageSize The maximum number of history events returned in each page. The
* default is 100, but the caller can override this value to a page size
* smaller than the default. You cannot specify a page size
* greater than 100. Note that the number of events may be less than the
* maxiumum page size, in which case, the returned page will have fewer
* results than the maximumPageSize specified.
*/
public void setMaximumPageSize(Integer maximumPageSize) {
this.maximumPageSize = maximumPageSize;
}
/**
* The maximum number of history events returned in each page. The
* default is 100, but the caller can override this value to a page size
* smaller than the default. You cannot specify a page size
* greater than 100. Note that the number of events may be less than the
* maxiumum page size, in which case, the returned page will have fewer
* results than the maximumPageSize specified.
*
* Returns a reference to this object so that method calls can be chained together.
*
* Constraints:
* Range: 0 - 1000
*
* @param maximumPageSize The maximum number of history events returned in each page. The
* default is 100, but the caller can override this value to a page size
* smaller than the default. You cannot specify a page size
* greater than 100. Note that the number of events may be less than the
* maxiumum page size, in which case, the returned page will have fewer
* results than the maximumPageSize specified.
*
* @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 true, returns the events in reverse order. By
* default the results are returned in ascending order of the
* eventTimestamp of the events.
*
* @return When set to true, returns the events in reverse order. By
* default the results are returned in ascending order of the
* eventTimestamp of the events.
*/
public Boolean isReverseOrder() {
return reverseOrder;
}
/**
* When set to true, returns the events in reverse order. By
* default the results are returned in ascending order of the
* eventTimestamp of the events.
*
* @param reverseOrder When set to true, returns the events in reverse order. By
* default the results are returned in ascending order of the
* eventTimestamp of the events.
*/
public void setReverseOrder(Boolean reverseOrder) {
this.reverseOrder = reverseOrder;
}
/**
* When set to true, returns the events in reverse order. By
* default the results are returned in ascending order of the
* eventTimestamp of the events.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param reverseOrder When set to true, returns the events in reverse order. By
* default the results are returned in ascending order of the
* eventTimestamp 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 true, returns the events in reverse order. By
* default the results are returned in ascending order of the
* eventTimestamp of the events.
*
* @return When set to true, returns the events in reverse order. By
* default the results are returned in ascending order of the
* eventTimestamp 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;
}
}