software.amazon.awssdk.services.swf.model

Interface PollForDecisionTaskRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<PollForDecisionTaskRequest.Builder,PollForDecisionTaskRequest>, SdkBuilder<PollForDecisionTaskRequest.Builder,PollForDecisionTaskRequest>, SdkPojo, SdkRequest.Builder, SwfRequest.Builder

Enclosing class:

PollForDecisionTaskRequest

public static interface PollForDecisionTaskRequest.Builder
extends SwfRequest.Builder, SdkPojo, CopyableBuilder<PollForDecisionTaskRequest.Builder,PollForDecisionTaskRequest>

Method Summary

Modifier and Type	Method and Description
PollForDecisionTaskRequest.Builder	domain(String domain) The name of the domain containing the task lists to poll.
PollForDecisionTaskRequest.Builder	identity(String identity) Identity of the decider making the request, which is recorded in the DecisionTaskStarted event in the workflow history.
PollForDecisionTaskRequest.Builder	maximumPageSize(Integer maximumPageSize) The maximum number of results that are returned per call.
PollForDecisionTaskRequest.Builder	nextPageToken(String nextPageToken) If NextPageToken is returned there are more results available.
PollForDecisionTaskRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
PollForDecisionTaskRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
PollForDecisionTaskRequest.Builder	reverseOrder(Boolean reverseOrder) When set to true, returns the events in reverse order.
PollForDecisionTaskRequest.Builder	startAtPreviousStartedEvent(Boolean startAtPreviousStartedEvent) When set to true, returns the events with eventTimestamp greater than or equal to eventTimestamp of the most recent DecisionTaskStarted event.
default PollForDecisionTaskRequest.Builder	taskList(Consumer<TaskList.Builder> taskList) Specifies the task list to poll for decision tasks.
PollForDecisionTaskRequest.Builder	taskList(TaskList taskList) Specifies the task list to poll for decision tasks.

Methods inherited from interface software.amazon.awssdk.services.swf.model.SwfRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

domain

PollForDecisionTaskRequest.Builder domain(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.

taskList

PollForDecisionTaskRequest.Builder taskList(TaskList taskList)

Specifies the task list to poll for decision tasks.

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

Parameters:

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

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

Returns:

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

taskList

default PollForDecisionTaskRequest.Builder taskList(Consumer<TaskList.Builder> taskList)

Specifies the task list to poll for decision tasks.

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

This is a convenience method that creates an instance of the TaskList.Builder avoiding the need to create one manually via TaskList.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to taskList(TaskList).

Parameters:

taskList - a consumer that will call methods on TaskList.Builder

Returns:

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

See Also:

taskList(TaskList)

identity

PollForDecisionTaskRequest.Builder identity(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.

nextPageToken

PollForDecisionTaskRequest.Builder nextPageToken(String nextPageToken)

If NextPageToken is returned there are more results available. The value of NextPageToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return a 400 error: " Specified token has exceeded its maximum lifetime".

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 the nextPageToken) to retrieve the next page of history records. Calling PollForDecisionTask with a nextPageToken doesn't return a new decision task.

Parameters:

nextPageToken - If NextPageToken is returned there are more results available. The value of NextPageToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return a 400 error: " Specified token has exceeded its maximum lifetime".

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 the nextPageToken) to retrieve the next page of history records. Calling PollForDecisionTask with a nextPageToken doesn't return a new decision task.

Returns:

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

maximumPageSize

PollForDecisionTaskRequest.Builder maximumPageSize(Integer maximumPageSize)

The maximum number of results that are returned per call. Use nextPageToken to obtain further pages of results.

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 are returned per call. Use nextPageToken to obtain further pages of results.

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.

reverseOrder

PollForDecisionTaskRequest.Builder reverseOrder(Boolean 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.

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:

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

startAtPreviousStartedEvent

PollForDecisionTaskRequest.Builder startAtPreviousStartedEvent(Boolean startAtPreviousStartedEvent)

When set to true, returns the events with eventTimestamp greater than or equal to eventTimestamp of the most recent DecisionTaskStarted event. By default, this parameter is set to false.

Parameters:

startAtPreviousStartedEvent - When set to true, returns the events with eventTimestamp greater than or equal to eventTimestamp of the most recent DecisionTaskStarted event. By default, this parameter is set to false.

Returns:

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

overrideConfiguration

PollForDecisionTaskRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

PollForDecisionTaskRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder