AWS SDK for .NET Documentation
PollForDecisionTaskRequest Class
AmazonAmazon.SimpleWorkflow.ModelPollForDecisionTaskRequest Did this page help you?   Yes   No    Tell us about it...
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:

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.

Declaration Syntax
C#
public class PollForDecisionTaskRequest : AmazonWebServiceRequest
Members
All MembersConstructorsMethodsProperties



IconMemberDescription
PollForDecisionTaskRequest()()()()
Initializes a new instance of the PollForDecisionTaskRequest class

Domain
The name of the domain containing the task lists to poll.

Constraints:

Length
1 - 256


Equals(Object)
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
GetHashCode()()()()
Serves as a hash function for a particular type.
(Inherited from Object.)
GetType()()()()
Gets the type of the current instance.
(Inherited from Object.)
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


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


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.
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.
.

Constraints:

Length
0 - 2048


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.

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".

ToString()()()()
Returns a string that represents the current object.
(Inherited from Object.)
WithDomain(String) Obsolete.
Sets the Domain property

WithIdentity(String) Obsolete.
Sets the Identity property

WithMaximumPageSize(Int32) Obsolete.
Sets the MaximumPageSize property

WithNextPageToken(String) Obsolete.
Sets the NextPageToken property

WithReverseOrder(Boolean) Obsolete.
Sets the ReverseOrder property

WithTaskList(TaskList) Obsolete.
Sets the TaskList property

Inheritance Hierarchy
Object
AmazonWebServiceRequest
 PollForDecisionTaskRequest
See Also

Assembly: AWSSDK (Module: AWSSDK) Version: 1.5.60.0 (1.5.60.0)