Interface ActivityTaskScheduledEventAttributes.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<ActivityTaskScheduledEventAttributes.Builder,
,ActivityTaskScheduledEventAttributes> SdkBuilder<ActivityTaskScheduledEventAttributes.Builder,
,ActivityTaskScheduledEventAttributes> SdkPojo
- Enclosing class:
ActivityTaskScheduledEventAttributes
-
Method Summary
Modifier and TypeMethodDescriptionactivityId
(String activityId) The unique ID of the activity task.activityType
(Consumer<ActivityType.Builder> activityType) The type of the activity task.activityType
(ActivityType activityType) The type of the activity task.Data attached to the event that can be used by the decider in subsequent workflow tasks.decisionTaskCompletedEventId
(Long decisionTaskCompletedEventId) The ID of theDecisionTaskCompleted
event corresponding to the decision that resulted in the scheduling of this activity task.heartbeatTimeout
(String heartbeatTimeout) The maximum time before which the worker processing this task must report progress by calling RecordActivityTaskHeartbeat.The input provided to the activity task.scheduleToCloseTimeout
(String scheduleToCloseTimeout) The maximum amount of time for this activity task.scheduleToStartTimeout
(String scheduleToStartTimeout) The maximum amount of time the activity task can wait to be assigned to a worker.startToCloseTimeout
(String startToCloseTimeout) The maximum amount of time a worker may take to process the activity task.taskList
(Consumer<TaskList.Builder> taskList) The task list in which the activity task has been scheduled.The task list in which the activity task has been scheduled.taskPriority
(String taskPriority) The priority to assign to the scheduled activity task.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
activityType
The type of the activity task.
- Parameters:
activityType
- The type of the activity task.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
activityType
default ActivityTaskScheduledEventAttributes.Builder activityType(Consumer<ActivityType.Builder> activityType) The type of the activity task.
This is a convenience method that creates an instance of theActivityType.Builder
avoiding the need to create one manually viaActivityType.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toactivityType(ActivityType)
.- Parameters:
activityType
- a consumer that will call methods onActivityType.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
activityId
The unique ID of the activity task.
- Parameters:
activityId
- The unique ID of the activity task.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
input
The input provided to the activity task.
- Parameters:
input
- The input provided to the activity task.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
scheduleToStartTimeout
The maximum amount of time the activity task can wait to be assigned to a worker.
- Parameters:
scheduleToStartTimeout
- The maximum amount of time the activity task can wait to be assigned to a worker.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
scheduleToCloseTimeout
The maximum amount of time for this activity task.
- Parameters:
scheduleToCloseTimeout
- The maximum amount of time for this activity task.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
startToCloseTimeout
The maximum amount of time a worker may take to process the activity task.
- Parameters:
startToCloseTimeout
- The maximum amount of time a worker may take to process the activity task.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
taskList
The task list in which the activity task has been scheduled.
- Parameters:
taskList
- The task list in which the activity task has been scheduled.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
taskList
The task list in which the activity task has been scheduled.
This is a convenience method that creates an instance of theTaskList.Builder
avoiding the need to create one manually viaTaskList.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed totaskList(TaskList)
.- Parameters:
taskList
- a consumer that will call methods onTaskList.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.
- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
decisionTaskCompletedEventId
ActivityTaskScheduledEventAttributes.Builder decisionTaskCompletedEventId(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.- Parameters:
decisionTaskCompletedEventId
- The ID of theDecisionTaskCompleted
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:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-