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("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.

  • Method Details

    • 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()
      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<PollForDecisionTaskResponse.Builder,PollForDecisionTaskResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. 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 SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      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

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.