software.amazon.awssdk.services.swf.model

Class PollForDecisionTaskResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.swf.model.SwfResponse

software.amazon.awssdk.services.swf.model.PollForDecisionTaskResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<PollForDecisionTaskResponse.Builder,PollForDecisionTaskResponse>

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

A structure that represents a decision task. Decision tasks are sent to deciders in order for them to make decisions.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	PollForDecisionTaskResponse.Builder

Method Summary

Modifier and Type	Method and Description
static PollForDecisionTaskResponse.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<HistoryEvent>	events() A paginated list of history events of the workflow execution.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasEvents() For responses, this returns true if the service returned a value for the Events property.
int	hashCode()
String	nextPageToken() If a NextPageToken was returned by a previous call, there are more results available.
Long	previousStartedEventId() The ID of the DecisionTaskStarted event of the previous decision task of this workflow execution that was processed by the decider.
List<SdkField<?>>	sdkFields()
static Class<? extends PollForDecisionTaskResponse.Builder>	serializableBuilderClass()
Long	startedEventId() The ID of the DecisionTaskStarted event recorded in the history.
String	taskToken() The opaque string used as a handle on the task.
PollForDecisionTaskResponse.Builder	toBuilder()
String	toString() Returns a string representation of this object.
WorkflowExecution	workflowExecution() The workflow execution for which this decision task was created.
WorkflowType	workflowType() The type of the workflow execution for which this decision task was created.

Methods inherited from class software.amazon.awssdk.services.swf.model.SwfResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

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

taskToken

public final String taskToken()

The opaque string used as a handle on the task. This token is used by workers to communicate progress and response information back to the system about the task.

Returns:

The opaque string used as a handle on the task. This token is used by workers to communicate progress and response information back to the system about the task.

startedEventId

public final Long startedEventId()

The ID of the DecisionTaskStarted event recorded in the history.

Returns:

The ID of the DecisionTaskStarted event recorded in the history.

workflowExecution

public final WorkflowExecution workflowExecution()

The workflow execution for which this decision task was created.

Returns:

The workflow execution for which this decision task was created.

workflowType

public final WorkflowType workflowType()

The type of the workflow execution for which this decision task was created.

Returns:

The type of the workflow execution for which this decision task was created.

hasEvents

public final boolean hasEvents()

For responses, this returns true if the service returned a value for the Events property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

events

public final List<HistoryEvent> events()

A paginated list of history events of the workflow execution. The decider uses this during the processing of the decision task.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasEvents() method.

Returns:

A paginated list of history events of the workflow execution. The decider uses this during the processing of the decision task.

nextPageToken

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

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.

previousStartedEventId

public final Long previousStartedEventId()

The ID of the DecisionTaskStarted event of the previous decision task of this workflow execution that was processed by the decider. This can be used to determine the events in the history new since the last decision task received by the decider.

Returns:

The ID of the DecisionTaskStarted event of the previous decision task of this workflow execution that was processed by the decider. This can be used to determine the events in the history new since the last decision task received by the decider.

toBuilder

public PollForDecisionTaskResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<PollForDecisionTaskResponse.Builder,PollForDecisionTaskResponse>

Overrides:

toBuilder in class AwsResponse

builder

public static PollForDecisionTaskResponse.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

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 SdkResponse

sdkFields

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

Specified by:

sdkFields in interface SdkPojo