Interface ActivityTypeConfiguration.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<ActivityTypeConfiguration.Builder,
,ActivityTypeConfiguration> SdkBuilder<ActivityTypeConfiguration.Builder,
,ActivityTypeConfiguration> SdkPojo
- Enclosing class:
ActivityTypeConfiguration
-
Method Summary
Modifier and TypeMethodDescriptiondefaultTaskHeartbeatTimeout
(String defaultTaskHeartbeatTimeout) The default maximum time, in seconds, before which a worker processing a task must report progress by calling RecordActivityTaskHeartbeat.defaultTaskList
(Consumer<TaskList.Builder> defaultTaskList) The default task list specified for this activity type at registration.defaultTaskList
(TaskList defaultTaskList) The default task list specified for this activity type at registration.defaultTaskPriority
(String defaultTaskPriority) The default task priority for tasks of this activity type, specified at registration.defaultTaskScheduleToCloseTimeout
(String defaultTaskScheduleToCloseTimeout) The default maximum duration, specified when registering the activity type, for tasks of this activity type.defaultTaskScheduleToStartTimeout
(String defaultTaskScheduleToStartTimeout) The default maximum duration, specified when registering the activity type, that a task of an activity type can wait before being assigned to a worker.defaultTaskStartToCloseTimeout
(String defaultTaskStartToCloseTimeout) The default maximum duration for tasks of an activity type specified when registering the activity type.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
-
defaultTaskStartToCloseTimeout
ActivityTypeConfiguration.Builder defaultTaskStartToCloseTimeout(String defaultTaskStartToCloseTimeout) The default maximum duration for tasks of an activity type specified when registering the activity type. You can override this default when scheduling a task through the
ScheduleActivityTask
Decision.The duration is specified in seconds, an integer greater than or equal to
0
. You can useNONE
to specify unlimited duration.- Parameters:
defaultTaskStartToCloseTimeout
- The default maximum duration for tasks of an activity type specified when registering the activity type. You can override this default when scheduling a task through theScheduleActivityTask
Decision.The duration is specified in seconds, an integer greater than or equal to
0
. You can useNONE
to specify unlimited duration.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
defaultTaskHeartbeatTimeout
The default maximum time, in seconds, before which a worker processing a task must report progress by calling RecordActivityTaskHeartbeat.
You can specify this value only when registering an activity type. The registered default value can be overridden when you schedule a task through the
ScheduleActivityTask
Decision. If the activity worker subsequently attempts to record a heartbeat or returns a result, the activity worker receives anUnknownResource
fault. In this case, Amazon SWF no longer considers the activity task to be valid; the activity worker should clean up the activity task.The duration is specified in seconds, an integer greater than or equal to
0
. You can useNONE
to specify unlimited duration.- Parameters:
defaultTaskHeartbeatTimeout
- The default maximum time, in seconds, before which a worker processing a task must report progress by calling RecordActivityTaskHeartbeat.You can specify this value only when registering an activity type. The registered default value can be overridden when you schedule a task through the
ScheduleActivityTask
Decision. If the activity worker subsequently attempts to record a heartbeat or returns a result, the activity worker receives anUnknownResource
fault. In this case, Amazon SWF no longer considers the activity task to be valid; the activity worker should clean up the activity task.The duration is specified in seconds, an integer greater than or equal to
0
. You can useNONE
to specify unlimited duration.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
defaultTaskList
The default task list specified for this activity type at registration. This default is used if a task list isn't provided when a task is scheduled through the
ScheduleActivityTask
Decision. You can override the default registered task list when scheduling a task through theScheduleActivityTask
Decision.- Parameters:
defaultTaskList
- The default task list specified for this activity type at registration. This default is used if a task list isn't provided when a task is scheduled through theScheduleActivityTask
Decision. You can override the default registered task list when scheduling a task through theScheduleActivityTask
Decision.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
defaultTaskList
default ActivityTypeConfiguration.Builder defaultTaskList(Consumer<TaskList.Builder> defaultTaskList) The default task list specified for this activity type at registration. This default is used if a task list isn't provided when a task is scheduled through the
This is a convenience method that creates an instance of theScheduleActivityTask
Decision. You can override the default registered task list when scheduling a task through theScheduleActivityTask
Decision.TaskList.Builder
avoiding the need to create one manually viaTaskList.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed todefaultTaskList(TaskList)
.- Parameters:
defaultTaskList
- 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:
-
defaultTaskPriority
The default task priority for tasks of this activity type, specified at registration. If not set, then
0
is used as the default priority. This default can be overridden when scheduling an activity task.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:
defaultTaskPriority
- The default task priority for tasks of this activity type, specified at registration. If not set, then0
is used as the default priority. This default can be overridden when scheduling an activity task.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.
-
defaultTaskScheduleToStartTimeout
ActivityTypeConfiguration.Builder defaultTaskScheduleToStartTimeout(String defaultTaskScheduleToStartTimeout) The default maximum duration, specified when registering the activity type, that a task of an activity type can wait before being assigned to a worker. You can override this default when scheduling a task through the
ScheduleActivityTask
Decision.The duration is specified in seconds, an integer greater than or equal to
0
. You can useNONE
to specify unlimited duration.- Parameters:
defaultTaskScheduleToStartTimeout
- The default maximum duration, specified when registering the activity type, that a task of an activity type can wait before being assigned to a worker. You can override this default when scheduling a task through theScheduleActivityTask
Decision.The duration is specified in seconds, an integer greater than or equal to
0
. You can useNONE
to specify unlimited duration.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
defaultTaskScheduleToCloseTimeout
ActivityTypeConfiguration.Builder defaultTaskScheduleToCloseTimeout(String defaultTaskScheduleToCloseTimeout) The default maximum duration, specified when registering the activity type, for tasks of this activity type. You can override this default when scheduling a task through the
ScheduleActivityTask
Decision.The duration is specified in seconds, an integer greater than or equal to
0
. You can useNONE
to specify unlimited duration.- Parameters:
defaultTaskScheduleToCloseTimeout
- The default maximum duration, specified when registering the activity type, for tasks of this activity type. You can override this default when scheduling a task through theScheduleActivityTask
Decision.The duration is specified in seconds, an integer greater than or equal to
0
. You can useNONE
to specify unlimited duration.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-