software.amazon.awssdk.services.swf.model

Interface ScheduleActivityTaskDecisionAttributes.Builder

All Superinterfaces:

CopyableBuilder<ScheduleActivityTaskDecisionAttributes.Builder,ScheduleActivityTaskDecisionAttributes>, SdkBuilder<ScheduleActivityTaskDecisionAttributes.Builder,ScheduleActivityTaskDecisionAttributes>

Enclosing class:

ScheduleActivityTaskDecisionAttributes

public static interface ScheduleActivityTaskDecisionAttributes.Builder
extends CopyableBuilder<ScheduleActivityTaskDecisionAttributes.Builder,ScheduleActivityTaskDecisionAttributes>

Method Summary

Modifier and Type	Method and Description
ScheduleActivityTaskDecisionAttributes.Builder	activityId(String activityId) The activityId of the activity task.
ScheduleActivityTaskDecisionAttributes.Builder	activityType(ActivityType activityType) The type of the activity task to schedule.
default ScheduleActivityTaskDecisionAttributes.Builder	activityType(Consumer<ActivityType.Builder> activityType) The type of the activity task to schedule.
ScheduleActivityTaskDecisionAttributes.Builder	control(String control) Data attached to the event that can be used by the decider in subsequent workflow tasks.
ScheduleActivityTaskDecisionAttributes.Builder	heartbeatTimeout(String heartbeatTimeout) If set, specifies the maximum time before which a worker processing a task of this type must report progress by calling RecordActivityTaskHeartbeat.
ScheduleActivityTaskDecisionAttributes.Builder	input(String input) The input provided to the activity task.
ScheduleActivityTaskDecisionAttributes.Builder	scheduleToCloseTimeout(String scheduleToCloseTimeout) The maximum duration for this activity task.
ScheduleActivityTaskDecisionAttributes.Builder	scheduleToStartTimeout(String scheduleToStartTimeout) If set, specifies the maximum duration the activity task can wait to be assigned to a worker.
ScheduleActivityTaskDecisionAttributes.Builder	startToCloseTimeout(String startToCloseTimeout) If set, specifies the maximum duration a worker may take to process this activity task.
default ScheduleActivityTaskDecisionAttributes.Builder	taskList(Consumer<TaskList.Builder> taskList) If set, specifies the name of the task list in which to schedule the activity task.
ScheduleActivityTaskDecisionAttributes.Builder	taskList(TaskList taskList) If set, specifies the name of the task list in which to schedule the activity task.
ScheduleActivityTaskDecisionAttributes.Builder	taskPriority(String taskPriority) If set, specifies the priority with which the activity task is to be assigned to a worker.

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

activityType

ScheduleActivityTaskDecisionAttributes.Builder activityType(ActivityType activityType)

The type of the activity task to schedule.

Parameters:

activityType - The type of the activity task to schedule.

Returns:

Returns a reference to this object so that method calls can be chained together.

activityType

default ScheduleActivityTaskDecisionAttributes.Builder activityType(Consumer<ActivityType.Builder> activityType)

The type of the activity task to schedule.

This is a convenience that creates an instance of the ActivityType.Builder avoiding the need to create one manually via ActivityType.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to activityType(ActivityType).

Parameters:

activityType - a consumer that will call methods on ActivityType.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

activityType(ActivityType)

activityId

ScheduleActivityTaskDecisionAttributes.Builder activityId(String activityId)

The activityId of the activity task.

The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (- | -Ÿ). Also, it must not contain the literal string arn.

Parameters:

activityId - The activityId of the activity task.

The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters ( - | -Ÿ). Also, it must not contain the literal string arn.

Returns:

Returns a reference to this object so that method calls can be chained together.

control

ScheduleActivityTaskDecisionAttributes.Builder control(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.

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.

input

ScheduleActivityTaskDecisionAttributes.Builder input(String 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.

scheduleToCloseTimeout

ScheduleActivityTaskDecisionAttributes.Builder scheduleToCloseTimeout(String scheduleToCloseTimeout)

The maximum duration for this activity task.

The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

A schedule-to-close timeout for this activity task must be specified either as a default for the activity type or through this field. If neither this field is set nor a default schedule-to-close timeout was specified at registration time then a fault is returned.

Parameters:

scheduleToCloseTimeout - The maximum duration for this activity task.

The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

A schedule-to-close timeout for this activity task must be specified either as a default for the activity type or through this field. If neither this field is set nor a default schedule-to-close timeout was specified at registration time then a fault is returned.

Returns:

Returns a reference to this object so that method calls can be chained together.

taskList

ScheduleActivityTaskDecisionAttributes.Builder taskList(TaskList taskList)

If set, specifies the name of the task list in which to schedule the activity task. If not specified, the defaultTaskList registered with the activity type is used.

A task list for this activity task must be specified either as a default for the activity type or through this field. If neither this field is set nor a default task list was specified at registration time then a fault is returned.

The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (- | -Ÿ). Also, it must not contain the literal string arn.

Parameters:

taskList - If set, specifies the name of the task list in which to schedule the activity task. If not specified, the defaultTaskList registered with the activity type is used.

A task list for this activity task must be specified either as a default for the activity type or through this field. If neither this field is set nor a default task list was specified at registration time then a fault is returned.

The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters ( - | -Ÿ). Also, it must not contain the literal string arn.

Returns:

Returns a reference to this object so that method calls can be chained together.

taskList

default ScheduleActivityTaskDecisionAttributes.Builder taskList(Consumer<TaskList.Builder> taskList)

If set, specifies the name of the task list in which to schedule the activity task. If not specified, the defaultTaskList registered with the activity type is used.

A task list for this activity task must be specified either as a default for the activity type or through this field. If neither this field is set nor a default task list was specified at registration time then a fault is returned.

The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (- | -Ÿ). Also, it must not contain the literal string arn.

This is a convenience that creates an instance of the TaskList.Builder avoiding the need to create one manually via TaskList.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to taskList(TaskList).

Parameters:

taskList - a consumer that will call methods on TaskList.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

taskList(TaskList)

taskPriority

ScheduleActivityTaskDecisionAttributes.Builder taskPriority(String taskPriority)

If set, specifies the priority with which the activity task is to be assigned to a worker. This overrides the defaultTaskPriority specified when registering the activity type using RegisterActivityType. 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.

Parameters:

taskPriority - If set, specifies the priority with which the activity task is to be assigned to a worker. This overrides the defaultTaskPriority specified when registering the activity type using RegisterActivityType. 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:

Returns a reference to this object so that method calls can be chained together.

scheduleToStartTimeout

ScheduleActivityTaskDecisionAttributes.Builder scheduleToStartTimeout(String scheduleToStartTimeout)

If set, specifies the maximum duration the activity task can wait to be assigned to a worker. This overrides the default schedule-to-start timeout specified when registering the activity type using RegisterActivityType.

The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

A schedule-to-start timeout for this activity task must be specified either as a default for the activity type or through this field. If neither this field is set nor a default schedule-to-start timeout was specified at registration time then a fault is returned.

Parameters:

scheduleToStartTimeout - If set, specifies the maximum duration the activity task can wait to be assigned to a worker. This overrides the default schedule-to-start timeout specified when registering the activity type using RegisterActivityType.

The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

A schedule-to-start timeout for this activity task must be specified either as a default for the activity type or through this field. If neither this field is set nor a default schedule-to-start timeout was specified at registration time then a fault is returned.

Returns:

Returns a reference to this object so that method calls can be chained together.

startToCloseTimeout

ScheduleActivityTaskDecisionAttributes.Builder startToCloseTimeout(String startToCloseTimeout)

If set, specifies the maximum duration a worker may take to process this activity task. This overrides the default start-to-close timeout specified when registering the activity type using RegisterActivityType.

The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

A start-to-close timeout for this activity task must be specified either as a default for the activity type or through this field. If neither this field is set nor a default start-to-close timeout was specified at registration time then a fault is returned.

Parameters:

startToCloseTimeout - If set, specifies the maximum duration a worker may take to process this activity task. This overrides the default start-to-close timeout specified when registering the activity type using RegisterActivityType.

The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

A start-to-close timeout for this activity task must be specified either as a default for the activity type or through this field. If neither this field is set nor a default start-to-close timeout was specified at registration time then a fault is returned.

Returns:

Returns a reference to this object so that method calls can be chained together.

heartbeatTimeout

ScheduleActivityTaskDecisionAttributes.Builder heartbeatTimeout(String heartbeatTimeout)

If set, specifies the maximum time before which a worker processing a task of this type 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 returns a result, it is ignored. This overrides the default heartbeat timeout specified when registering the activity type using RegisterActivityType.

The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

Parameters:

heartbeatTimeout - If set, specifies the maximum time before which a worker processing a task of this type 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 returns a result, it is ignored. This overrides the default heartbeat timeout specified when registering the activity type using RegisterActivityType.

The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

Returns:

Returns a reference to this object so that method calls can be chained together.