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:

ToCopyableBuilder<PollForDecisionTaskRequest.Builder,PollForDecisionTaskRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	PollForDecisionTaskRequest.Builder

Method Summary

Modifier and Type	Method and Description
static PollForDecisionTaskRequest.Builder	builder()
String	domain() The name of the domain containing the task lists to poll.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
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 a NextPageToken was returned by a previous call, there are more results available.
Boolean	reverseOrder() When set to true, returns the events in reverse order.
static Class<? extends PollForDecisionTaskRequest.Builder>	serializableBuilderClass()
TaskList	taskList() Specifies the task list to poll for decision tasks.
PollForDecisionTaskRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

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

overrideConfiguration

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

domain

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

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

identity

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

maximumPageSize

public Integer maximumPageSize()

The maximum number of results that are 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 are 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.

reverseOrder

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

toBuilder

public PollForDecisionTaskRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<PollForDecisionTaskRequest.Builder,PollForDecisionTaskRequest>

Specified by:

toBuilder in class SwfRequest

Returns:

a builder for type T

builder

public static PollForDecisionTaskRequest.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

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

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value