Class PollForDecisionTaskRequest
- java.lang.Object
-
- com.amazonaws.AmazonWebServiceRequest
-
- com.amazonaws.services.simpleworkflow.model.PollForDecisionTaskRequest
-
- All Implemented Interfaces:
ReadLimitInfo
,Serializable
,Cloneable
public class PollForDecisionTaskRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
- See Also:
- Serialized Form
-
-
Field Summary
-
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
-
Constructor Summary
Constructors Constructor Description PollForDecisionTaskRequest()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description PollForDecisionTaskRequest
clone()
Creates a shallow clone of this request.boolean
equals(Object obj)
String
getDomain()
The name of the domain containing the task lists to poll.String
getIdentity()
Identity of the decider making the request, which is recorded in the DecisionTaskStarted event in the workflow history.Integer
getMaximumPageSize()
The maximum number of results that will be returned per call.String
getNextPageToken()
If aNextPageToken
was returned by a previous call, there are more results available.Boolean
getReverseOrder()
When set totrue
, returns the events in reverse order.TaskList
getTaskList()
Specifies the task list to poll for decision tasks.int
hashCode()
Boolean
isReverseOrder()
When set totrue
, returns the events in reverse order.void
setDomain(String domain)
The name of the domain containing the task lists to poll.void
setIdentity(String identity)
Identity of the decider making the request, which is recorded in the DecisionTaskStarted event in the workflow history.void
setMaximumPageSize(Integer maximumPageSize)
The maximum number of results that will be returned per call.void
setNextPageToken(String nextPageToken)
If aNextPageToken
was returned by a previous call, there are more results available.void
setReverseOrder(Boolean reverseOrder)
When set totrue
, returns the events in reverse order.void
setTaskList(TaskList taskList)
Specifies the task list to poll for decision tasks.String
toString()
Returns a string representation of this object; useful for testing and debugging.PollForDecisionTaskRequest
withDomain(String domain)
The name of the domain containing the task lists to poll.PollForDecisionTaskRequest
withIdentity(String identity)
Identity of the decider making the request, which is recorded in the DecisionTaskStarted event in the workflow history.PollForDecisionTaskRequest
withMaximumPageSize(Integer maximumPageSize)
The maximum number of results that will be returned per call.PollForDecisionTaskRequest
withNextPageToken(String nextPageToken)
If aNextPageToken
was returned by a previous call, there are more results available.PollForDecisionTaskRequest
withReverseOrder(Boolean reverseOrder)
When set totrue
, returns the events in reverse order.PollForDecisionTaskRequest
withTaskList(TaskList taskList)
Specifies the task list to poll for decision tasks.-
Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
-
-
-
-
Method Detail
-
setDomain
public void setDomain(String domain)
The name of the domain containing the task lists to poll.
- Parameters:
domain
- The name of the domain containing the task lists to poll.
-
getDomain
public String getDomain()
The name of the domain containing the task lists to poll.
- Returns:
- The name of the domain containing the task lists to poll.
-
withDomain
public PollForDecisionTaskRequest withDomain(String domain)
The name of the domain containing the task lists to poll.
- Parameters:
domain
- The name of the domain containing the task lists to poll.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setTaskList
public void setTaskList(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 ( - | - ). Also, it must not contain the literal string quotarnquot.- 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 ( - | - ). Also, it must not contain the literal string quotarnquot.
-
getTaskList
public TaskList getTaskList()
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 ( - | - ). Also, it must not contain the literal string quotarnquot.- 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 ( - | - ). Also, it must not contain the literal string quotarnquot.
-
withTaskList
public PollForDecisionTaskRequest withTaskList(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 ( - | - ). Also, it must not contain the literal string quotarnquot.- 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 ( - | - ). Also, it must not contain the literal string quotarnquot.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setIdentity
public void setIdentity(String 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.
- 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.
-
getIdentity
public String getIdentity()
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:
- 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.
-
withIdentity
public PollForDecisionTaskRequest withIdentity(String 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.
- 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:
- Returns a reference to this object so that method calls can be chained together.
-
setNextPageToken
public void setNextPageToken(String 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 innextPageToken
. Keep all other arguments unchanged.The configured
maximumPageSize
determines how many results can be returned in a single call.The .nextPageToken
returned by this action cannot be used with GetWorkflowExecutionHistory to get the next page. You must call PollForDecisionTask again (with thenextPageToken
) to retrieve the next page of history records. Calling PollForDecisionTask with anextPageToken
will not return a new decision task.- Parameters:
nextPageToken
- If aNextPageToken
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 innextPageToken
. Keep all other arguments unchanged.The configured
maximumPageSize
determines how many results can be returned in a single call.The nextPageToken
returned by this action cannot be used with GetWorkflowExecutionHistory to get the next page. You must call PollForDecisionTask again (with thenextPageToken
) to retrieve the next page of history records. Calling PollForDecisionTask with anextPageToken
will not return a new decision task.
-
getNextPageToken
public String getNextPageToken()
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 innextPageToken
. Keep all other arguments unchanged.The configured
maximumPageSize
determines how many results can be returned in a single call.The .nextPageToken
returned by this action cannot be used with GetWorkflowExecutionHistory to get the next page. You must call PollForDecisionTask again (with thenextPageToken
) to retrieve the next page of history records. Calling PollForDecisionTask with anextPageToken
will not return a new decision task.- 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 innextPageToken
. Keep all other arguments unchanged.The configured
maximumPageSize
determines how many results can be returned in a single call.The nextPageToken
returned by this action cannot be used with GetWorkflowExecutionHistory to get the next page. You must call PollForDecisionTask again (with thenextPageToken
) to retrieve the next page of history records. Calling PollForDecisionTask with anextPageToken
will not return a new decision task.
-
withNextPageToken
public PollForDecisionTaskRequest withNextPageToken(String 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 innextPageToken
. Keep all other arguments unchanged.The configured
maximumPageSize
determines how many results can be returned in a single call.The .nextPageToken
returned by this action cannot be used with GetWorkflowExecutionHistory to get the next page. You must call PollForDecisionTask again (with thenextPageToken
) to retrieve the next page of history records. Calling PollForDecisionTask with anextPageToken
will not return a new decision task.- Parameters:
nextPageToken
- If aNextPageToken
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 innextPageToken
. Keep all other arguments unchanged.The configured
maximumPageSize
determines how many results can be returned in a single call.The nextPageToken
returned by this action cannot be used with GetWorkflowExecutionHistory to get the next page. You must call PollForDecisionTask again (with thenextPageToken
) to retrieve the next page of history records. Calling PollForDecisionTask with anextPageToken
will not return a new decision task.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setMaximumPageSize
public void setMaximumPageSize(Integer 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 1000, which is the maximum allowed page size. You can, however, specify a page size smaller than the maximum.This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.
- 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 1000, which is the maximum allowed page size. You can, however, specify a page size smaller than the maximum.This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.
-
getMaximumPageSize
public Integer getMaximumPageSize()
The maximum number of results that will be returned per call.
nextPageToken
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 smaller than the maximum.This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.
- 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 1000, which is the maximum allowed page size. You can, however, specify a page size smaller than the maximum.This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.
-
withMaximumPageSize
public PollForDecisionTaskRequest withMaximumPageSize(Integer 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 1000, which is the maximum allowed page size. You can, however, specify a page size smaller than the maximum.This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.
- 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 1000, which is the maximum allowed page size. You can, however, specify a page size smaller than the maximum.This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setReverseOrder
public void setReverseOrder(Boolean reverseOrder)
When set to
true
, returns the events in reverse order. By default the results are returned in ascending order of theeventTimestamp
of the events.- Parameters:
reverseOrder
- When set totrue
, returns the events in reverse order. By default the results are returned in ascending order of theeventTimestamp
of the events.
-
getReverseOrder
public Boolean getReverseOrder()
When set to
true
, returns the events in reverse order. By default the results are returned in ascending order of theeventTimestamp
of the events.- Returns:
- When set to
true
, returns the events in reverse order. By default the results are returned in ascending order of theeventTimestamp
of the events.
-
withReverseOrder
public PollForDecisionTaskRequest withReverseOrder(Boolean reverseOrder)
When set to
true
, returns the events in reverse order. By default the results are returned in ascending order of theeventTimestamp
of the events.- Parameters:
reverseOrder
- When set totrue
, returns the events in reverse order. By default the results are returned in ascending order of theeventTimestamp
of the events.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
isReverseOrder
public Boolean isReverseOrder()
When set to
true
, returns the events in reverse order. By default the results are returned in ascending order of theeventTimestamp
of the events.- Returns:
- When set to
true
, returns the events in reverse order. By default the results are returned in ascending order of theeventTimestamp
of the events.
-
toString
public String toString()
Returns a string representation of this object; useful for testing and debugging.- Overrides:
toString
in classObject
- Returns:
- A string representation of this object.
- See Also:
Object.toString()
-
clone
public PollForDecisionTaskRequest clone()
Description copied from class:AmazonWebServiceRequest
Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.- Overrides:
clone
in classAmazonWebServiceRequest
- See Also:
Object.clone()
-
-