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:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
ActivityTaskScheduledEventAttributes.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description String
activityId()
The unique ID of the activity task.ActivityType
activityType()
The type of the activity task.static ActivityTaskScheduledEventAttributes.Builder
builder()
String
control()
Data attached to the event that can be used by the decider in subsequent workflow tasks.Long
decisionTaskCompletedEventId()
The ID of theDecisionTaskCompleted
event corresponding to the decision that resulted in the scheduling of this activity task.boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
int
hashCode()
String
heartbeatTimeout()
The maximum time before which the worker processing this task must report progress by calling RecordActivityTaskHeartbeat.String
input()
The input provided to the activity task.String
scheduleToCloseTimeout()
The maximum amount of time for this activity task.String
scheduleToStartTimeout()
The maximum amount of time the activity task can wait to be assigned to a worker.Map<String,SdkField<?>>
sdkFieldNameToField()
List<SdkField<?>>
sdkFields()
static Class<? extends ActivityTaskScheduledEventAttributes.Builder>
serializableBuilderClass()
String
startToCloseTimeout()
The maximum amount of time a worker may take to process the activity task.TaskList
taskList()
The task list in which the activity task has been scheduled.String
taskPriority()
The priority to assign to the scheduled activity task.ActivityTaskScheduledEventAttributes.Builder
toBuilder()
String
toString()
Returns a string representation of this object.-
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
-
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) toInteger.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) toInteger.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()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<ActivityTaskScheduledEventAttributes.Builder,ActivityTaskScheduledEventAttributes>
-
builder
public static ActivityTaskScheduledEventAttributes.Builder builder()
-
serializableBuilderClass
public static Class<? extends ActivityTaskScheduledEventAttributes.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
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.
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToField
in interfaceSdkPojo
-
-