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>

  • Method Details

    • 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()
      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 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)
      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: 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

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