Package software.amazon.awssdk.services.swf.model

Interface ActivityTypeConfiguration.Builder

All Superinterfaces:

CopyableBuilder<ActivityTypeConfiguration.Builder,ActivityTypeConfiguration>, SdkBuilder<ActivityTypeConfiguration.Builder,ActivityTypeConfiguration>

Enclosing class:

ActivityTypeConfiguration

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

Method Summary

Modifier and Type	Method	Description
ActivityTypeConfiguration.Builder	defaultTaskHeartbeatTimeout(String defaultTaskHeartbeatTimeout)	Optional. The default maximum time, in seconds, before which a worker processing a task must report progress by calling RecordActivityTaskHeartbeat.
ActivityTypeConfiguration.Builder	defaultTaskList(TaskList defaultTaskList)	Optional. The default task list specified for this activity type at registration.
ActivityTypeConfiguration.Builder	defaultTaskPriority(String defaultTaskPriority)	Optional. The default task priority for tasks of this activity type, specified at registration.
ActivityTypeConfiguration.Builder	defaultTaskScheduleToCloseTimeout(String defaultTaskScheduleToCloseTimeout)	Optional. The default maximum duration, specified when registering the activity type, for tasks of this activity type.
ActivityTypeConfiguration.Builder	defaultTaskScheduleToStartTimeout(String defaultTaskScheduleToStartTimeout)	Optional. 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.
ActivityTypeConfiguration.Builder	defaultTaskStartToCloseTimeout(String defaultTaskStartToCloseTimeout)	Optional. 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

apply, build

Method Detail

defaultTaskStartToCloseTimeout

ActivityTypeConfiguration.Builder defaultTaskStartToCloseTimeout(String defaultTaskStartToCloseTimeout)

Optional. 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. The value "NONE" can be used to specify unlimited duration.

Parameters:

defaultTaskStartToCloseTimeout - Optional. 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.

Returns:

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

defaultTaskHeartbeatTimeout

ActivityTypeConfiguration.Builder defaultTaskHeartbeatTimeout(String defaultTaskHeartbeatTimeout)

Optional. 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 an UnknownResource 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. The value "NONE" can be used to specify unlimited duration.

Parameters:

defaultTaskHeartbeatTimeout - Optional. 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 an UnknownResource fault. In this case, Amazon SWF no longer considers the activity task to be valid; the activity worker should clean up the activity task.

Returns:

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

defaultTaskList

ActivityTypeConfiguration.Builder defaultTaskList(TaskList defaultTaskList)

Optional. The default task list specified for this activity type at registration. This default is used if a task list is not provided when a task is scheduled through the ScheduleActivityTask decision. You can override the default registered task list when scheduling a task through the ScheduleActivityTask decision.

Parameters:

defaultTaskList - Optional. The default task list specified for this activity type at registration. This default is used if a task list is not provided when a task is scheduled through the ScheduleActivityTask decision. You can override the default registered task list when scheduling a task through the ScheduleActivityTask

Returns:

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

defaultTaskPriority

ActivityTypeConfiguration.Builder defaultTaskPriority(String defaultTaskPriority)

Optional. The default task priority for tasks of this activity type, specified at registration. If not set, then "0" will be 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) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.

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

Parameters:

defaultTaskPriority - Optional. The default task priority for tasks of this activity type, specified at registration. If not set, then "0" will be 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) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.

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

Returns:

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

defaultTaskScheduleToStartTimeout

ActivityTypeConfiguration.Builder defaultTaskScheduleToStartTimeout(String defaultTaskScheduleToStartTimeout)

Optional. 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. The value "NONE" can be used to specify unlimited duration.

Parameters:

defaultTaskScheduleToStartTimeout - Optional. 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.

Returns:

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

defaultTaskScheduleToCloseTimeout

ActivityTypeConfiguration.Builder defaultTaskScheduleToCloseTimeout(String defaultTaskScheduleToCloseTimeout)

Optional. 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. The value "NONE" can be used to specify unlimited duration.

Parameters:

defaultTaskScheduleToCloseTimeout - Optional. 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.

Returns:

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