public class ScheduleActivityTaskDecisionAttributes extends Object implements Serializable, Cloneable
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:
Resource
element with the domain name to limit the action to only specified domains.Action
element to allow or deny permission to call this action.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.
Constructor and Description |
---|
ScheduleActivityTaskDecisionAttributes() |
Modifier and Type | Method and Description |
---|---|
ScheduleActivityTaskDecisionAttributes |
clone() |
boolean |
equals(Object obj) |
String |
getActivityId()
Required. The
activityId of the activity task. |
ActivityType |
getActivityType()
Required. 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()
Optional. 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.
|
String |
getTaskPriority()
Optional. If set, specifies the priority with which the activity task is to be assigned to a worker.
|
int |
hashCode() |
void |
setActivityId(String activityId)
Required. The
activityId of the activity task. |
void |
setActivityType(ActivityType activityType)
Required. 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)
Optional. 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.
|
void |
setTaskPriority(String taskPriority)
Optional. If set, specifies the priority with which the activity task is to be assigned to a worker.
|
String |
toString()
Returns a string representation of this object; useful for testing and debugging.
|
ScheduleActivityTaskDecisionAttributes |
withActivityId(String activityId)
Required. The
activityId of the activity task. |
ScheduleActivityTaskDecisionAttributes |
withActivityType(ActivityType activityType)
Required. 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)
Optional. 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.
|
ScheduleActivityTaskDecisionAttributes |
withTaskPriority(String taskPriority)
Optional. If set, specifies the priority with which the activity task is to be assigned to a worker.
|
public ScheduleActivityTaskDecisionAttributes()
public void setActivityType(ActivityType activityType)
Required. The type of the activity task to schedule.
activityType
- Required.public ActivityType getActivityType()
Required. The type of the activity task to schedule.
public ScheduleActivityTaskDecisionAttributes withActivityType(ActivityType activityType)
Required. The type of the activity task to schedule.
activityType
- Required.public void setActivityId(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.
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), |
public String getActivityId()
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.
activityId
of the activity task.
The specified string must not start or end with whitespace. It must not contain a :
(colon),
/
(slash), |
public ScheduleActivityTaskDecisionAttributes withActivityId(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.
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), |
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.
control
- Optional.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.
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.
control
- Optional.public void setInput(String input)
The input provided to the activity task.
input
- The input provided to the activity task.public String getInput()
The input provided to the activity task.
public ScheduleActivityTaskDecisionAttributes withInput(String input)
The input provided to the activity task.
input
- The input provided to the activity task.public void setScheduleToCloseTimeout(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.
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.
public String getScheduleToCloseTimeout()
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.
The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.
public ScheduleActivityTaskDecisionAttributes withScheduleToCloseTimeout(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.
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.
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.
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.
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.
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.
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.
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.
defaultTaskList
registered with the activity type will be used.
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.
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.
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.
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.
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.
public void setTaskPriority(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.
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
public String getTaskPriority()
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.
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
public ScheduleActivityTaskDecisionAttributes withTaskPriority(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.
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
public void setScheduleToStartTimeout(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.
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.
public String getScheduleToStartTimeout()
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.
The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.
public ScheduleActivityTaskDecisionAttributes withScheduleToStartTimeout(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.
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.
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 duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.
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.
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 duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.
The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.
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 duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.
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.
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 duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.
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.
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 duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.
The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.
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 duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.
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.
public String toString()
toString
in class Object
Object.toString()
public ScheduleActivityTaskDecisionAttributes clone()
Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.