Class PollForActivityTaskResponse

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.PollForActivityTaskResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<PollForActivityTaskResponse.Builder,PollForActivityTaskResponse>
@Generated("software.amazon.awssdk:codegen") public final class PollForActivityTaskResponse extends SwfResponse implements ToCopyableBuilder<PollForActivityTaskResponse.Builder,PollForActivityTaskResponse>

Unit of work sent to an activity worker.

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

    • activityId

      public final String activityId()

      The unique ID of the task.

      Returns:
      The unique ID of the task.

    • startedEventId

      public final Long startedEventId()

      The ID of the ActivityTaskStarted event recorded in the history.

      Returns:
      The ID of the ActivityTaskStarted event recorded in the history.

    • workflowExecution

      public final WorkflowExecution workflowExecution()

      The workflow execution that started this activity task.

      Returns:
      The workflow execution that started this activity task.

    • activityType

      public final ActivityType activityType()

      The type of this activity task.

      Returns:
      The type of this activity task.

    • input

      public final String input()

      The inputs provided when the activity task was scheduled. The form of the input is user defined and should be meaningful to the activity implementation.

      Returns:
      The inputs provided when the activity task was scheduled. The form of the input is user defined and should be meaningful to the activity implementation.

    • toBuilder

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

    • builder

      public static PollForActivityTaskResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends PollForActivityTaskResponse.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.