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

Class ScheduleActivityTaskDecisionAttributes

java.lang.Object

software.amazon.awssdk.services.swf.model.ScheduleActivityTaskDecisionAttributes

All Implemented Interfaces:

StructuredPojo, ToCopyableBuilder<ScheduleActivityTaskDecisionAttributes.Builder,ScheduleActivityTaskDecisionAttributes>

@Generated("software.amazon.awssdk:codegen")
public class ScheduleActivityTaskDecisionAttributes
extends Object
implements StructuredPojo, ToCopyableBuilder<ScheduleActivityTaskDecisionAttributes.Builder,ScheduleActivityTaskDecisionAttributes>

Provides details of the ScheduleActivityTask decision.

Access Control

You can use IAM policies to control this decision's access to Amazon SWF resources as follows:

• Use a Resource element with the domain name to limit the action to only specified domains.
• Use an Action element to allow or deny permission to call this action.
• Constrain the following parameters by using a Condition element with the appropriate keys.
  • activityType.name: String constraint. The key is swf:activityType.name.
  • activityType.version: String constraint. The key is swf:activityType.version.
  • taskList: String constraint. The key is swf:taskList.name.

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ScheduleActivityTaskDecisionAttributes.Builder

Method Summary

Modifier and Type	Method	Description
String	activityId()	Required. The activityId of the activity task.
ActivityType	activityType()	Required. The type of the activity task to schedule.
static ScheduleActivityTaskDecisionAttributes.Builder	builder()
String	control()	Optional. Data attached to the event that can be used by the decider in subsequent workflow tasks.
boolean	equals(Object obj)
int	hashCode()
String	heartbeatTimeout()	If set, specifies the maximum time before which a worker processing a task of this type must report progress by calling RecordActivityTaskHeartbeat.
String	input()	The input provided to the activity task.
void	marshall(ProtocolMarshaller protocolMarshaller)	Marshalls this structured data using the given ProtocolMarshaller.
String	scheduleToCloseTimeout()	The maximum duration for this activity task.
String	scheduleToStartTimeout()	Optional. If set, specifies the maximum duration the activity task can wait to be assigned to a worker.
static Class<? extends ScheduleActivityTaskDecisionAttributes.Builder>	serializableBuilderClass()
String	startToCloseTimeout()	If set, specifies the maximum duration a worker may take to process this activity task.
TaskList	taskList()	If set, specifies the name of the task list in which to schedule the activity task.
String	taskPriority()	Optional. If set, specifies the priority with which the activity task is to be assigned to a worker.
ScheduleActivityTaskDecisionAttributes.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

activityType

public ActivityType activityType()

Required. The type of the activity task to schedule.

Returns:

Required.

activityId

public String activityId()

Required. 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 quotarnquot.

Returns:

Required. The activityId of the activity task.

The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), |

control

public String control()

Optional. Data attached to the event that can be used by the decider in subsequent workflow tasks. This data is not sent to the activity.

Returns:

Optional.

input

public String input()

The input provided to the activity task.

Returns:

The input provided to the activity task.

scheduleToCloseTimeout

public String scheduleToCloseTimeout()

The maximum duration for this 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.

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 will be returned.

Returns:

The maximum duration for this 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.

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 will be returned.

taskList

public 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 will be 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 will be 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 quotarnquot.

Returns:

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 will be 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 will be 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 quotarnquot.

taskPriority

public String taskPriority()

Optional. 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 Simple Workflow Developer Guide.

Returns:

Optional. 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 Simple Workflow Developer Guide

scheduleToStartTimeout

public String scheduleToStartTimeout()

Optional. 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. The value "NONE" can be used 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 will be returned.

Returns:

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

startToCloseTimeout

public 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. The value "NONE" can be used 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 will be returned.

Returns:

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. The value "NONE" can be used 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 will be returned.

heartbeatTimeout

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

Returns:

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

toBuilder

public ScheduleActivityTaskDecisionAttributes.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<ScheduleActivityTaskDecisionAttributes.Builder,ScheduleActivityTaskDecisionAttributes>

Returns:

a builder for type T

builder

public static ScheduleActivityTaskDecisionAttributes.Builder builder()

serializableBuilderClass

public static Class<? extends ScheduleActivityTaskDecisionAttributes.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.