Class ActivityTaskScheduledEventAttributes

java.lang.Object
software.amazon.awssdk.services.swf.model.ActivityTaskScheduledEventAttributes
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<ActivityTaskScheduledEventAttributes.Builder,ActivityTaskScheduledEventAttributes>
@Generated("software.amazon.awssdk:codegen") public final class ActivityTaskScheduledEventAttributes extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ActivityTaskScheduledEventAttributes.Builder,ActivityTaskScheduledEventAttributes>

Provides the details of the ActivityTaskScheduled event.

See Also:

  • Method Details

    • activityType

      public final ActivityType activityType()

      The type of the activity task.

      Returns:
      The type of the activity task.

    • activityId

      public final String activityId()

      The unique ID of the activity task.

      Returns:
      The unique ID of the activity task.

    • input

      public final String input()

      The input provided to the activity task.

      Returns:
      The input provided to the activity task.

    • control

      public final String control()

      Data attached to the event that can be used by the decider in subsequent workflow tasks. This data isn't sent to the activity.

      Returns:
      Data attached to the event that can be used by the decider in subsequent workflow tasks. This data isn't sent to the activity.

    • scheduleToStartTimeout

      public final String scheduleToStartTimeout()

      The maximum amount of time the activity task can wait to be assigned to a worker.

      Returns:
      The maximum amount of time the activity task can wait to be assigned to a worker.

    • scheduleToCloseTimeout

      public final String scheduleToCloseTimeout()

      The maximum amount of time for this activity task.

      Returns:
      The maximum amount of time for this activity task.

    • startToCloseTimeout

      public final String startToCloseTimeout()

      The maximum amount of time a worker may take to process the activity task.

      Returns:
      The maximum amount of time a worker may take to process the activity task.

    • taskList

      public final TaskList taskList()

      The task list in which the activity task has been scheduled.

      Returns:
      The task list in which the activity task has been scheduled.

    • taskPriority

      public final String taskPriority()

      The priority to assign to the scheduled activity task. If set, this overrides any default priority value that was assigned when the activity type was registered.

      Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.

      For more information about setting task priority, see Setting Task Priority in the Amazon SWF Developer Guide.

      Returns:
      The priority to assign to the scheduled activity task. If set, this overrides any default priority value that was assigned when the activity type was registered.

      Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.

      For more information about setting task priority, see Setting Task Priority in the Amazon SWF Developer Guide.

    • decisionTaskCompletedEventId

      public final Long decisionTaskCompletedEventId()

      The ID of the DecisionTaskCompleted event corresponding to the decision that resulted in the scheduling of this activity task. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

      Returns:
      The ID of the DecisionTaskCompleted event corresponding to the decision that resulted in the scheduling of this activity task. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

    • heartbeatTimeout

      public final String heartbeatTimeout()

      The maximum time before which the worker processing this task must report progress by calling RecordActivityTaskHeartbeat. If the timeout is exceeded, the activity task is automatically timed out. If the worker subsequently attempts to record a heartbeat or return a result, it is ignored.

      Returns:
      The maximum time before which the worker processing this task must report progress by calling RecordActivityTaskHeartbeat. If the timeout is exceeded, the activity task is automatically timed out. If the worker subsequently attempts to record a heartbeat or return a result, it is ignored.

    • toBuilder

      public ActivityTaskScheduledEventAttributes.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<ActivityTaskScheduledEventAttributes.Builder,ActivityTaskScheduledEventAttributes>
      Returns:
      a builder for type T

    • builder

      public static ActivityTaskScheduledEventAttributes.Builder builder()

    • serializableBuilderClass

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

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

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

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.