public class RegisterActivityTypeRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
RegisterActivityType operation
.
Registers a new activity type along with its configuration settings in the specified domain.
IMPORTANT:A TypeAlreadyExists fault is returned if the type already exists in the domain. You cannot change any configuration settings of the type after its registration, and it must be registered as a new version.
Access Control
You can use IAM policies to control this action'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.
defaultTaskList.name
: String constraint. The key
is swf:defaultTaskList.name
.name
: String constraint. The key is
swf:name
.version
: String constraint. The key is
swf:version
.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 .
NOOP
Constructor and Description |
---|
RegisterActivityTypeRequest() |
Modifier and Type | Method and Description |
---|---|
RegisterActivityTypeRequest |
clone()
Creates a shallow clone of this request.
|
boolean |
equals(Object obj) |
String |
getDefaultTaskHeartbeatTimeout()
If set, specifies the default maximum time before which a worker
processing a task of this type must report progress by calling
RecordActivityTaskHeartbeat.
|
TaskList |
getDefaultTaskList()
If set, specifies the default task list to use for scheduling tasks of
this activity type.
|
String |
getDefaultTaskPriority()
The default task priority to assign to the activity type.
|
String |
getDefaultTaskScheduleToCloseTimeout()
If set, specifies the default maximum duration for a task of this
activity type.
|
String |
getDefaultTaskScheduleToStartTimeout()
If set, specifies the default maximum duration that a task of this
activity type can wait before being assigned to a worker.
|
String |
getDefaultTaskStartToCloseTimeout()
If set, specifies the default maximum duration that a worker can take
to process tasks of this activity type.
|
String |
getDescription()
A textual description of the activity type.
|
String |
getDomain()
The name of the domain in which this activity is to be registered.
|
String |
getName()
The name of the activity type within the domain.
|
String |
getVersion()
The version of the activity type.
|
int |
hashCode() |
void |
setDefaultTaskHeartbeatTimeout(String defaultTaskHeartbeatTimeout)
If set, specifies the default maximum time before which a worker
processing a task of this type must report progress by calling
RecordActivityTaskHeartbeat.
|
void |
setDefaultTaskList(TaskList defaultTaskList)
If set, specifies the default task list to use for scheduling tasks of
this activity type.
|
void |
setDefaultTaskPriority(String defaultTaskPriority)
The default task priority to assign to the activity type.
|
void |
setDefaultTaskScheduleToCloseTimeout(String defaultTaskScheduleToCloseTimeout)
If set, specifies the default maximum duration for a task of this
activity type.
|
void |
setDefaultTaskScheduleToStartTimeout(String defaultTaskScheduleToStartTimeout)
If set, specifies the default maximum duration that a task of this
activity type can wait before being assigned to a worker.
|
void |
setDefaultTaskStartToCloseTimeout(String defaultTaskStartToCloseTimeout)
If set, specifies the default maximum duration that a worker can take
to process tasks of this activity type.
|
void |
setDescription(String description)
A textual description of the activity type.
|
void |
setDomain(String domain)
The name of the domain in which this activity is to be registered.
|
void |
setName(String name)
The name of the activity type within the domain.
|
void |
setVersion(String version)
The version of the activity type.
|
String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
RegisterActivityTypeRequest |
withDefaultTaskHeartbeatTimeout(String defaultTaskHeartbeatTimeout)
If set, specifies the default maximum time before which a worker
processing a task of this type must report progress by calling
RecordActivityTaskHeartbeat.
|
RegisterActivityTypeRequest |
withDefaultTaskList(TaskList defaultTaskList)
If set, specifies the default task list to use for scheduling tasks of
this activity type.
|
RegisterActivityTypeRequest |
withDefaultTaskPriority(String defaultTaskPriority)
The default task priority to assign to the activity type.
|
RegisterActivityTypeRequest |
withDefaultTaskScheduleToCloseTimeout(String defaultTaskScheduleToCloseTimeout)
If set, specifies the default maximum duration for a task of this
activity type.
|
RegisterActivityTypeRequest |
withDefaultTaskScheduleToStartTimeout(String defaultTaskScheduleToStartTimeout)
If set, specifies the default maximum duration that a task of this
activity type can wait before being assigned to a worker.
|
RegisterActivityTypeRequest |
withDefaultTaskStartToCloseTimeout(String defaultTaskStartToCloseTimeout)
If set, specifies the default maximum duration that a worker can take
to process tasks of this activity type.
|
RegisterActivityTypeRequest |
withDescription(String description)
A textual description of the activity type.
|
RegisterActivityTypeRequest |
withDomain(String domain)
The name of the domain in which this activity is to be registered.
|
RegisterActivityTypeRequest |
withName(String name)
The name of the activity type within the domain.
|
RegisterActivityTypeRequest |
withVersion(String version)
The version of the activity type.
|
getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
public String getDomain()
Constraints:
Length: 1 - 256
public void setDomain(String domain)
Constraints:
Length: 1 - 256
domain
- The name of the domain in which this activity is to be registered.public RegisterActivityTypeRequest withDomain(String domain)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 256
domain
- The name of the domain in which this activity is to be registered.public String getName()
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
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".
public void setName(String name)
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
name
- The name of the activity type within the domain. 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".
public RegisterActivityTypeRequest withName(String name)
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
name
- The name of the activity type within the domain. 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".
public String getVersion()
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 - 64
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".
public void setVersion(String version)
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 - 64
version
- The version of the activity type. 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".
public RegisterActivityTypeRequest withVersion(String version)
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 - 64
version
- The version of the activity type. 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".
public String getDescription()
Constraints:
Length: 0 - 1024
public void setDescription(String description)
Constraints:
Length: 0 - 1024
description
- A textual description of the activity type.public RegisterActivityTypeRequest withDescription(String description)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 0 - 1024
description
- A textual description of the activity type.public String getDefaultTaskStartToCloseTimeout()
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.
Constraints:
Length: 0 - 8
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.
public void setDefaultTaskStartToCloseTimeout(String defaultTaskStartToCloseTimeout)
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.
Constraints:
Length: 0 - 8
defaultTaskStartToCloseTimeout
- If set, specifies the default maximum duration that a worker can take
to process tasks of this activity type. This default can be overridden
when scheduling an activity task using 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.
public RegisterActivityTypeRequest withDefaultTaskStartToCloseTimeout(String defaultTaskStartToCloseTimeout)
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.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 0 - 8
defaultTaskStartToCloseTimeout
- If set, specifies the default maximum duration that a worker can take
to process tasks of this activity type. This default can be overridden
when scheduling an activity task using 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.
public String getDefaultTaskHeartbeatTimeout()
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.
Constraints:
Length: 0 - 8
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.
public void setDefaultTaskHeartbeatTimeout(String defaultTaskHeartbeatTimeout)
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.
Constraints:
Length: 0 - 8
defaultTaskHeartbeatTimeout
- If set, specifies the default 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. This default can be
overridden when scheduling an activity task using 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.
public RegisterActivityTypeRequest withDefaultTaskHeartbeatTimeout(String defaultTaskHeartbeatTimeout)
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.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 0 - 8
defaultTaskHeartbeatTimeout
- If set, specifies the default 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. This default can be
overridden when scheduling an activity task using 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.
public TaskList getDefaultTaskList()
ScheduleActivityTask
decision.ScheduleActivityTask
decision.public void setDefaultTaskList(TaskList defaultTaskList)
ScheduleActivityTask
decision.defaultTaskList
- If set, specifies the default task list to use for scheduling tasks of
this activity type. This default task list is used if a task list is
not provided when a task is scheduled through the
ScheduleActivityTask
decision.public RegisterActivityTypeRequest withDefaultTaskList(TaskList defaultTaskList)
ScheduleActivityTask
decision.
Returns a reference to this object so that method calls can be chained together.
defaultTaskList
- If set, specifies the default task list to use for scheduling tasks of
this activity type. This default task list is used if a task list is
not provided when a task is scheduled through the
ScheduleActivityTask
decision.public String getDefaultTaskPriority()
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.
Constraints:
Length: 0 - 11
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 setDefaultTaskPriority(String defaultTaskPriority)
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.
Constraints:
Length: 0 - 11
defaultTaskPriority
- The default task priority to assign to the activity type. If not
assigned, then "0" will be used. 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 RegisterActivityTypeRequest withDefaultTaskPriority(String defaultTaskPriority)
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 a reference to this object so that method calls can be chained together.
Constraints:
Length: 0 - 11
defaultTaskPriority
- The default task priority to assign to the activity type. If not
assigned, then "0" will be used. 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 getDefaultTaskScheduleToStartTimeout()
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.
Constraints:
Length: 0 - 8
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.
public void setDefaultTaskScheduleToStartTimeout(String defaultTaskScheduleToStartTimeout)
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.
Constraints:
Length: 0 - 8
defaultTaskScheduleToStartTimeout
- If set, specifies the default maximum duration that a task of this
activity type can wait before being assigned to a worker. This default
can be overridden when scheduling an activity task using 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.
public RegisterActivityTypeRequest withDefaultTaskScheduleToStartTimeout(String defaultTaskScheduleToStartTimeout)
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.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 0 - 8
defaultTaskScheduleToStartTimeout
- If set, specifies the default maximum duration that a task of this
activity type can wait before being assigned to a worker. This default
can be overridden when scheduling an activity task using 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.
public String getDefaultTaskScheduleToCloseTimeout()
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.
Constraints:
Length: 0 - 8
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.
public void setDefaultTaskScheduleToCloseTimeout(String defaultTaskScheduleToCloseTimeout)
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.
Constraints:
Length: 0 - 8
defaultTaskScheduleToCloseTimeout
- If set, specifies the default maximum duration for a task of this
activity type. This default can be overridden when scheduling an
activity task using 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.
public RegisterActivityTypeRequest withDefaultTaskScheduleToCloseTimeout(String defaultTaskScheduleToCloseTimeout)
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.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 0 - 8
defaultTaskScheduleToCloseTimeout
- If set, specifies the default maximum duration for a task of this
activity type. This default can be overridden when scheduling an
activity task using 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.
public String toString()
toString
in class Object
Object.toString()
public RegisterActivityTypeRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()
Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.