com.amazonaws.services.simpleworkflow.model

Class PollForActivityTaskRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.simpleworkflow.model.PollForActivityTaskRequest

All Implemented Interfaces:

Serializable

public class PollForActivityTaskRequest
extends AmazonWebServiceRequest
implements Serializable

Container for the parameters to the PollForActivityTask operation.

Used by workers to get an ActivityTask from the specified activity taskList . This initiates a long poll, where the service holds the HTTP connection open and responds as soon as a task becomes available. The maximum time the service holds on to the request before responding is 60 seconds. If no task is available within 60 seconds, the poll will return an empty result. An empty result, in this context, means that an ActivityTask is returned, but that the value of taskToken is an empty string. If a task is returned, the worker should use its type to identify and process it correctly.

IMPORTANT: Workers should set their client side socket timeout to at least 70 seconds (10 seconds higher than the maximum time service may hold the poll request).

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

AmazonSimpleWorkflow.pollForActivityTask(PollForActivityTaskRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
PollForActivityTaskRequest()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getDomain() The name of the domain that contains the task lists being polled.
String	getIdentity() Identity of the worker making the request, which is recorded in the ActivityTaskStarted event in the workflow history.
TaskList	getTaskList() Specifies the task list to poll for activity tasks.
int	hashCode()
void	setDomain(String domain) The name of the domain that contains the task lists being polled.
void	setIdentity(String identity) Identity of the worker making the request, which is recorded in the ActivityTaskStarted event in the workflow history.
void	setTaskList(TaskList taskList) Specifies the task list to poll for activity tasks.
String	toString() Returns a string representation of this object; useful for testing and debugging.
PollForActivityTaskRequest	withDomain(String domain) The name of the domain that contains the task lists being polled.
PollForActivityTaskRequest	withIdentity(String identity) Identity of the worker making the request, which is recorded in the ActivityTaskStarted event in the workflow history.
PollForActivityTaskRequest	withTaskList(TaskList taskList) Specifies the task list to poll for activity tasks.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyPrivateRequestParameters, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

PollForActivityTaskRequest

public PollForActivityTaskRequest()

Method Detail

getDomain

public String getDomain()

The name of the domain that contains the task lists being polled.

Constraints:
Length: 1 - 256

Returns:

The name of the domain that contains the task lists being polled.

setDomain

public void setDomain(String domain)

The name of the domain that contains the task lists being polled.

Constraints:
Length: 1 - 256

Parameters:

domain - The name of the domain that contains the task lists being polled.

withDomain

public PollForActivityTaskRequest withDomain(String domain)

The name of the domain that contains the task lists being polled.

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 that contains the task lists being polled.

Returns:

A reference to this updated object so that method calls can be chained together.

getTaskList

public TaskList getTaskList()

Specifies the task list to poll for activity tasks.

The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (- |  - Ÿ). Also, it must not contain the literal string "arn".

Returns:

Specifies the task list to poll for activity tasks.

The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (- |  - Ÿ). Also, it must not contain the literal string "arn".

setTaskList

public void setTaskList(TaskList taskList)

Specifies the task list to poll for activity tasks.

The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (- |  - Ÿ). Also, it must not contain the literal string "arn".

Parameters:

taskList - Specifies the task list to poll for activity tasks.

The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (- |  - Ÿ). Also, it must not contain the literal string "arn".

withTaskList

public PollForActivityTaskRequest withTaskList(TaskList taskList)

Specifies the task list to poll for activity tasks.

The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (- |  - Ÿ). 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 activity tasks.

The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (- |  - Ÿ). Also, it must not contain the literal string "arn".

Returns:

A reference to this updated object so that method calls can be chained together.

getIdentity

public String getIdentity()

Identity of the worker making the request, which is recorded in the ActivityTaskStarted 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 worker making the request, which is recorded in the ActivityTaskStarted event in the workflow history. This enables diagnostic tracing when problems arise. The form of this identity is user defined.

setIdentity

public void setIdentity(String identity)

Identity of the worker making the request, which is recorded in the ActivityTaskStarted 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 worker making the request, which is recorded in the ActivityTaskStarted event in the workflow history. This enables diagnostic tracing when problems arise. The form of this identity is user defined.

withIdentity

public PollForActivityTaskRequest withIdentity(String identity)

Identity of the worker making the request, which is recorded in the ActivityTaskStarted 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 worker making the request, which is recorded in the ActivityTaskStarted 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.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object