Package software.amazon.awssdk.services.swf.model

Class PollForDecisionTaskRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.swf.model.SwfRequest

software.amazon.awssdk.services.swf.model.PollForDecisionTaskRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<PollForDecisionTaskRequest.Builder,PollForDecisionTaskRequest>

@Generated("software.amazon.awssdk:codegen")
public final class PollForDecisionTaskRequest
extends SwfRequest
implements ToCopyableBuilder<PollForDecisionTaskRequest.Builder,PollForDecisionTaskRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	PollForDecisionTaskRequest.Builder

Method Summary

Modifier and Type	Method	Description
static PollForDecisionTaskRequest.Builder	builder()
String	domain()	The name of the domain containing the task lists to poll.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	identity()	Identity of the decider making the request, which is recorded in the DecisionTaskStarted event in the workflow history.
Integer	maximumPageSize()	The maximum number of results that are returned per call.
String	nextPageToken()	If NextPageToken is returned there are more results available.
Boolean	reverseOrder()	When set to true, returns the events in reverse order.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends PollForDecisionTaskRequest.Builder>	serializableBuilderClass()
Boolean	startAtPreviousStartedEvent()	When set to true, returns the events with eventTimestamp greater than or equal to eventTimestamp of the most recent DecisionTaskStarted event.
TaskList	taskList()	Specifies the task list to poll for decision tasks.
PollForDecisionTaskRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

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

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

copy

Method Detail

domain

public final String domain()

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

Returns:

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

taskList

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

Returns:

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.

identity

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

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.

nextPageToken

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

Returns:

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.

maximumPageSize

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

Returns:

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.

reverseOrder

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

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.

startAtPreviousStartedEvent

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

Returns:

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.

toBuilder

public PollForDecisionTaskRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<PollForDecisionTaskRequest.Builder,PollForDecisionTaskRequest>

Specified by:

toBuilder in class SwfRequest

builder

public static PollForDecisionTaskRequest.Builder builder()

serializableBuilderClass

public static Class<? extends PollForDecisionTaskRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo