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 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.
  • Constrain the taskList.name parameter by using 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. 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 PollForDecisionTaskRequest extends AmazonWebServiceRequest implements SerializableCloneable {

    
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 a NextPageToken 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 nextPageToken. Keep all other arguments unchanged.

The configured maximumPageSize determines how many results can be returned in a single call. <note>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.</note>.

Constraints:
Length: 0 - 2048

    private String nextPageToken;

    
The maximum number of results that will be returned per call. nextPageToken can be used to obtain futher pages of results. The default is 100, which is the maximum allowed page size. You can, however, specify a page size smaller than 100.

This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.

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

Returns:
The name of the domain containing the task lists to poll.
    public String getDomain() {
        return ;
    }
    
    
The name of the domain containing the task lists to poll.

Constraints:
Length: 1 - 256

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

Parameters:
domain The name of the domain containing the task lists to poll.
Returns:
A reference to this updated object so that method calls can be chained together.
    public PollForDecisionTaskRequest withDomain(String domain) {
        this. = 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".

Returns:
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 ;
    }
    
    
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".

Parameters:
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;
    }
    
    
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.

Parameters:
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 updated object so that method calls can be chained together.
    public PollForDecisionTaskRequest withTaskList(TaskList taskList) {
        this. = 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

Returns:
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 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

Parameters:
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 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

Parameters:
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 updated object so that method calls can be chained together.
    public PollForDecisionTaskRequest withIdentity(String identity) {
        this. = identity;
        return this;
    }

    
If a NextPageToken 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 nextPageToken. Keep all other arguments unchanged.

The configured maximumPageSize determines how many results can be returned in a single call. <note>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.</note>.

Constraints:
Length: 0 - 2048

Returns:
If a NextPageToken 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 nextPageToken. Keep all other arguments unchanged.

The configured maximumPageSize determines how many results can be returned in a single call. <note>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.</note>.

    public String getNextPageToken() {
        return ;
    }
    
    
If a NextPageToken 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 nextPageToken. Keep all other arguments unchanged.

The configured maximumPageSize determines how many results can be returned in a single call. <note>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.</note>.

Constraints:
Length: 0 - 2048

Parameters:
nextPageToken If a NextPageToken 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 nextPageToken. Keep all other arguments unchanged.

The configured maximumPageSize determines how many results can be returned in a single call. <note>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.</note>.

    public void setNextPageToken(String nextPageToken) {
        this. = nextPageToken;
    }
    
    
If a NextPageToken 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 nextPageToken. Keep all other arguments unchanged.

The configured maximumPageSize determines how many results can be returned in a single call. <note>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.</note>.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 0 - 2048

Parameters:
nextPageToken If a NextPageToken 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 nextPageToken. Keep all other arguments unchanged.

The configured maximumPageSize determines how many results can be returned in a single call. <note>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.</note>.

Returns:
A reference to this updated object so that method calls can be chained together.
    public PollForDecisionTaskRequest withNextPageToken(String nextPageToken) {
        this. = nextPageToken;
        return this;
    }

    
The maximum number of results that will be returned per call. nextPageToken can be used to obtain futher pages of results. The default is 100, which is the maximum allowed page size. You can, however, specify a page size smaller than 100.

This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.

Constraints:
Range: 0 - 1000

Returns:
The maximum number of results that will be returned per call. nextPageToken can be used to obtain futher pages of results. The default is 100, which is the maximum allowed page size. You can, however, specify a page size smaller than 100.

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 ;
    }
    
    
The maximum number of results that will be returned per call. nextPageToken can be used to obtain futher pages of results. The default is 100, which is the maximum allowed page size. You can, however, specify a page size smaller than 100.

This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.

Constraints:
Range: 0 - 1000

Parameters:
maximumPageSize The maximum number of results that will be returned per call. nextPageToken can be used to obtain futher pages of results. The default is 100, which is the maximum allowed page size. You can, however, specify a page size smaller than 100.

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;
    }
    
    
The maximum number of results that will be returned per call. nextPageToken can be used to obtain futher pages of results. The default is 100, which is the maximum allowed page size. You can, however, specify a page size smaller than 100.

This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Range: 0 - 1000

Parameters:
maximumPageSize The maximum number of results that will be returned per call. nextPageToken can be used to obtain futher pages of results. The default is 100, which is the maximum allowed page size. You can, however, specify a page size smaller than 100.

This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.

Returns:
A reference to this updated object so that method calls can be chained together.
    public PollForDecisionTaskRequest withMaximumPageSize(Integer maximumPageSize) {
        this. = 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.

Returns:
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 ;
    }
    
    
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.

Parameters:
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;
    }
    
    
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.

Parameters:
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 updated object so that method calls can be chained together.
    public PollForDecisionTaskRequest withReverseOrder(Boolean reverseOrder) {
        this. = 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.

Returns:
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 ;
    }

    
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 (getTaskList() != nullsb.append("TaskList: " + getTaskList() + ",");
        if (getIdentity() != nullsb.append("Identity: " + getIdentity() + ",");
        if (getNextPageToken() != nullsb.append("NextPageToken: " + getNextPageToken() + ",");
        if (getMaximumPageSize() != nullsb.append("MaximumPageSize: " + getMaximumPageSize() + ",");
        if (isReverseOrder() != nullsb.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 == objreturn true;
        if (obj == nullreturn false;
        if (obj instanceof PollForDecisionTaskRequest == falsereturn false;
        
        if (other.getDomain() == null ^ this.getDomain() == nullreturn false;
        if (other.getDomain() != null && other.getDomain().equals(this.getDomain()) == falsereturn false
        if (other.getTaskList() == null ^ this.getTaskList() == nullreturn false;
        if (other.getTaskList() != null && other.getTaskList().equals(this.getTaskList()) == falsereturn false
        if (other.getIdentity() == null ^ this.getIdentity() == nullreturn false;
        if (other.getIdentity() != null && other.getIdentity().equals(this.getIdentity()) == falsereturn false
        if (other.getNextPageToken() == null ^ this.getNextPageToken() == nullreturn false;
        if (other.getNextPageToken() != null && other.getNextPageToken().equals(this.getNextPageToken()) == falsereturn false
        if (other.getMaximumPageSize() == null ^ this.getMaximumPageSize() == nullreturn false;
        if (other.getMaximumPageSize() != null && other.getMaximumPageSize().equals(this.getMaximumPageSize()) == falsereturn false
        if (other.isReverseOrder() == null ^ this.isReverseOrder() == nullreturn false;
        if (other.isReverseOrder() != null && other.isReverseOrder().equals(this.isReverseOrder()) == falsereturn false
        return true;
    }
    
    @Override
    public PollForDecisionTaskRequest clone() {
        
            return (PollForDecisionTaskRequestsuper.clone();
    }
}
    
New to GrepCode? Check out our FAQ X