com.amazonaws.services.simpleworkflow.model

Class ScheduleActivityTaskDecisionAttributes

java.lang.Object

com.amazonaws.services.simpleworkflow.model.ScheduleActivityTaskDecisionAttributes

All Implemented Interfaces:

Serializable

public class ScheduleActivityTaskDecisionAttributes
extends Object
implements Serializable

Provides details of the ScheduleActivityTask decision.

Access Control

You can use IAM policies to control this decision's access to Amazon SWF in much the same way as for the regular API:

• Use a Resource element with the domain name to limit the decision to only specified domains.
• Use an Action element to allow or deny permission to specify this decision.
• 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 .

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ScheduleActivityTaskDecisionAttributes()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getActivityId() The activityId of the activity task.
ActivityType	getActivityType() The type of the activity task to schedule.
String	getControl() Optional data attached to the event that can be used by the decider in subsequent workflow tasks.
String	getHeartbeatTimeout() If set, specifies the maximum time before which a worker processing a task of this type must report progress by calling RecordActivityTaskHeartbeat.
String	getInput() The input provided to the activity task.
String	getScheduleToCloseTimeout() The maximum duration for this activity task.
String	getScheduleToStartTimeout() If set, specifies the maximum duration the activity task can wait to be assigned to a worker.
String	getStartToCloseTimeout() If set, specifies the maximum duration a worker may take to process this activity task.
TaskList	getTaskList() If set, specifies the name of the task list in which to schedule the activity task.
int	hashCode()
void	setActivityId(String activityId) The activityId of the activity task.
void	setActivityType(ActivityType activityType) The type of the activity task to schedule.
void	setControl(String control) Optional data attached to the event that can be used by the decider in subsequent workflow tasks.
void	setHeartbeatTimeout(String heartbeatTimeout) If set, specifies the maximum time before which a worker processing a task of this type must report progress by calling RecordActivityTaskHeartbeat.
void	setInput(String input) The input provided to the activity task.
void	setScheduleToCloseTimeout(String scheduleToCloseTimeout) The maximum duration for this activity task.
void	setScheduleToStartTimeout(String scheduleToStartTimeout) If set, specifies the maximum duration the activity task can wait to be assigned to a worker.
void	setStartToCloseTimeout(String startToCloseTimeout) If set, specifies the maximum duration a worker may take to process this activity task.
void	setTaskList(TaskList taskList) If set, specifies the name of the task list in which to schedule the activity task.
String	toString() Returns a string representation of this object; useful for testing and debugging.
ScheduleActivityTaskDecisionAttributes	withActivityId(String activityId) The activityId of the activity task.
ScheduleActivityTaskDecisionAttributes	withActivityType(ActivityType activityType) The type of the activity task to schedule.
ScheduleActivityTaskDecisionAttributes	withControl(String control) Optional data attached to the event that can be used by the decider in subsequent workflow tasks.
ScheduleActivityTaskDecisionAttributes	withHeartbeatTimeout(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	withInput(String input) The input provided to the activity task.
ScheduleActivityTaskDecisionAttributes	withScheduleToCloseTimeout(String scheduleToCloseTimeout) The maximum duration for this activity task.
ScheduleActivityTaskDecisionAttributes	withScheduleToStartTimeout(String scheduleToStartTimeout) If set, specifies the maximum duration the activity task can wait to be assigned to a worker.
ScheduleActivityTaskDecisionAttributes	withStartToCloseTimeout(String startToCloseTimeout) If set, specifies the maximum duration a worker may take to process this activity task.
ScheduleActivityTaskDecisionAttributes	withTaskList(TaskList taskList) If set, specifies the name of the task list in which to schedule the activity task.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ScheduleActivityTaskDecisionAttributes

public ScheduleActivityTaskDecisionAttributes()

Method Detail

getActivityType

public ActivityType getActivityType()

The type of the activity task to schedule. This field is required.

Returns:

The type of the activity task to schedule. This field is required.

setActivityType

public void setActivityType(ActivityType activityType)

The type of the activity task to schedule. This field is required.

Parameters:

activityType - The type of the activity task to schedule. This field is required.

withActivityType

public ScheduleActivityTaskDecisionAttributes withActivityType(ActivityType activityType)

The type of the activity task to schedule. This field is required.

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

Parameters:

activityType - The type of the activity task to schedule. This field is required.

Returns:

A reference to this updated object so that method calls can be chained together.

getActivityId

public String getActivityId()

The activityId of the activity task. This field is required.

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".

Constraints:
Length: 1 - 256

Returns:

The activityId of the activity task. This field is required.

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".

setActivityId

public void setActivityId(String activityId)

The activityId of the activity task. This field is required.

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".

Constraints:
Length: 1 - 256

Parameters:

activityId - The activityId of the activity task. This field is required.

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".

withActivityId

public ScheduleActivityTaskDecisionAttributes withActivityId(String activityId)

The activityId of the activity task. This field is required.

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 a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 256

Parameters:

activityId - The activityId of the activity task. This field is required.

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:

A reference to this updated object so that method calls can be chained together.

getControl

public String getControl()

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.

Constraints:
Length: 0 - 32768

Returns:

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.

setControl

public void setControl(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.

Constraints:
Length: 0 - 32768

Parameters:

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.

withControl

public ScheduleActivityTaskDecisionAttributes withControl(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 a reference to this object so that method calls can be chained together.

Constraints:
Length: 0 - 32768

Parameters:

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:

A reference to this updated object so that method calls can be chained together.

getInput

public String getInput()

The input provided to the activity task.

Constraints:
Length: 0 - 32768

Returns:

The input provided to the activity task.

setInput

public void setInput(String input)

The input provided to the activity task.

Constraints:
Length: 0 - 32768

Parameters:

input - The input provided to the activity task.

withInput

public ScheduleActivityTaskDecisionAttributes withInput(String input)

The input provided to the activity task.

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

Constraints:
Length: 0 - 32768

Parameters:

input - The input provided to the activity task.

Returns:

A reference to this updated object so that method calls can be chained together.

getScheduleToCloseTimeout

public String getScheduleToCloseTimeout()

The maximum duration for this activity task.

The valid values are integers greater than or equal to 0. An integer value can be used to specify the duration in seconds while 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.

Constraints:
Length: 0 - 8

Returns:

The maximum duration for this activity task.

The valid values are integers greater than or equal to 0. An integer value can be used to specify the duration in seconds while 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.

setScheduleToCloseTimeout

public void setScheduleToCloseTimeout(String scheduleToCloseTimeout)

The maximum duration for this activity task.

The valid values are integers greater than or equal to 0. An integer value can be used to specify the duration in seconds while 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.

Constraints:
Length: 0 - 8

Parameters:

scheduleToCloseTimeout - The maximum duration for this activity task.

The valid values are integers greater than or equal to 0. An integer value can be used to specify the duration in seconds while 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.

withScheduleToCloseTimeout

public ScheduleActivityTaskDecisionAttributes withScheduleToCloseTimeout(String scheduleToCloseTimeout)

The maximum duration for this activity task.

The valid values are integers greater than or equal to 0. An integer value can be used to specify the duration in seconds while 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 a reference to this object so that method calls can be chained together.

Constraints:
Length: 0 - 8

Parameters:

scheduleToCloseTimeout - The maximum duration for this activity task.

The valid values are integers greater than or equal to 0. An integer value can be used to specify the duration in seconds while 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:

A reference to this updated object so that method calls can be chained together.

getTaskList

public TaskList getTaskList()

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 "arn".

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 "arn".

setTaskList

public void setTaskList(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 "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 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 "arn".

withTaskList

public ScheduleActivityTaskDecisionAttributes withTaskList(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 "arn".

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

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 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 "arn".

Returns:

A reference to this updated object so that method calls can be chained together.

getScheduleToStartTimeout

public String getScheduleToStartTimeout()

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 valid values are integers greater than or equal to 0. An integer value can be used to specify the duration in seconds while 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.

Constraints:
Length: 0 - 8

Returns:

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 valid values are integers greater than or equal to 0. An integer value can be used to specify the duration in seconds while 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.

setScheduleToStartTimeout

public void setScheduleToStartTimeout(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 valid values are integers greater than or equal to 0. An integer value can be used to specify the duration in seconds while 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.

Constraints:
Length: 0 - 8

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 valid values are integers greater than or equal to 0. An integer value can be used to specify the duration in seconds while 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.

withScheduleToStartTimeout

public ScheduleActivityTaskDecisionAttributes withScheduleToStartTimeout(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 valid values are integers greater than or equal to 0. An integer value can be used to specify the duration in seconds while 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 a reference to this object so that method calls can be chained together.

Constraints:
Length: 0 - 8

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 valid values are integers greater than or equal to 0. An integer value can be used to specify the duration in seconds while 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:

A reference to this updated object so that method calls can be chained together.

getStartToCloseTimeout

public String getStartToCloseTimeout()

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 valid values are integers greater than or equal to 0. An integer value can be used to specify the duration in seconds while 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.

Constraints:
Length: 0 - 8

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 valid values are integers greater than or equal to 0. An integer value can be used to specify the duration in seconds while 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.

setStartToCloseTimeout

public void setStartToCloseTimeout(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 valid values are integers greater than or equal to 0. An integer value can be used to specify the duration in seconds while 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.

Constraints:
Length: 0 - 8

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 valid values are integers greater than or equal to 0. An integer value can be used to specify the duration in seconds while 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.

withStartToCloseTimeout

public ScheduleActivityTaskDecisionAttributes withStartToCloseTimeout(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 valid values are integers greater than or equal to 0. An integer value can be used to specify the duration in seconds while 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 a reference to this object so that method calls can be chained together.

Constraints:
Length: 0 - 8

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 valid values are integers greater than or equal to 0. An integer value can be used to specify the duration in seconds while 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:

A reference to this updated object so that method calls can be chained together.

getHeartbeatTimeout

public String getHeartbeatTimeout()

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 valid values are integers greater than or equal to 0. An integer value can be used to specify the duration in seconds while NONE can be used to specify unlimited duration.

Constraints:
Length: 0 - 8

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 valid values are integers greater than or equal to 0. An integer value can be used to specify the duration in seconds while NONE can be used to specify unlimited duration.

setHeartbeatTimeout

public void setHeartbeatTimeout(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 valid values are integers greater than or equal to 0. An integer value can be used to specify the duration in seconds while NONE can be used to specify unlimited duration.

Constraints:
Length: 0 - 8

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 will be ignored. This overrides the default heartbeat timeout specified when registering the activity type using RegisterActivityType.

The valid values are integers greater than or equal to 0. An integer value can be used to specify the duration in seconds while NONE can be used to specify unlimited duration.

withHeartbeatTimeout

public ScheduleActivityTaskDecisionAttributes withHeartbeatTimeout(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 valid values are integers greater than or equal to 0. An integer value can be used to specify the duration in seconds while NONE can be used to specify unlimited duration.

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

Constraints:
Length: 0 - 8

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 will be ignored. This overrides the default heartbeat timeout specified when registering the activity type using RegisterActivityType.

The valid values are integers greater than or equal to 0. An integer value can be used to specify the duration in seconds while NONE can be used to specify unlimited duration.

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object