Class RegisterActivityTypeRequest
- java.lang.Object
-
- com.amazonaws.AmazonWebServiceRequest
-
- com.amazonaws.services.simpleworkflow.model.RegisterActivityTypeRequest
-
- All Implemented Interfaces:
ReadLimitInfo
,Serializable
,Cloneable
public class RegisterActivityTypeRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
- See Also:
- Serialized Form
-
-
Field Summary
-
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
-
Constructor Summary
Constructors Constructor Description RegisterActivityTypeRequest()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method 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.-
Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
-
-
-
-
Method Detail
-
setDomain
public void setDomain(String domain)
The name of the domain in which this activity is to be registered.
- Parameters:
domain
- The name of the domain in which this activity is to be registered.
-
getDomain
public String getDomain()
The name of the domain in which this activity is to be registered.
- Returns:
- The name of the domain in which this activity is to be registered.
-
withDomain
public RegisterActivityTypeRequest withDomain(String domain)
The name of the domain in which this activity is to be registered.
- Parameters:
domain
- The name of the domain in which this activity is to be registered.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setName
public void setName(String 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 quotarnquot.- Parameters:
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 quotarnquot.
-
getName
public String getName()
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 quotarnquot.- Returns:
- 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 quotarnquot.
-
withName
public RegisterActivityTypeRequest withName(String 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 quotarnquot.- Parameters:
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 quotarnquot.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setVersion
public void setVersion(String version)
The version of the activity type.
The activity type consists of the name and version, the combination of which must be unique 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 quotarnquot.- Parameters:
version
- The version of the activity type.The activity type consists of the name and version, the combination of which must be unique 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 quotarnquot.
-
getVersion
public String getVersion()
The version of the activity type.
The activity type consists of the name and version, the combination of which must be unique 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 quotarnquot.- Returns:
- The version of the activity type.
The activity type consists of the name and version, the combination of which must be unique 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 quotarnquot.
-
withVersion
public RegisterActivityTypeRequest withVersion(String version)
The version of the activity type.
The activity type consists of the name and version, the combination of which must be unique 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 quotarnquot.- Parameters:
version
- The version of the activity type.The activity type consists of the name and version, the combination of which must be unique 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 quotarnquot.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setDescription
public void setDescription(String description)
A textual description of the activity type.
- Parameters:
description
- A textual description of the activity type.
-
getDescription
public String getDescription()
A textual description of the activity type.
- Returns:
- A textual description of the activity type.
-
withDescription
public RegisterActivityTypeRequest withDescription(String description)
A textual description of the activity type.
- Parameters:
description
- A textual description of the activity type.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setDefaultTaskStartToCloseTimeout
public void setDefaultTaskStartToCloseTimeout(String 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.
- Parameters:
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 theScheduleActivityTask
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.
-
getDefaultTaskStartToCloseTimeout
public String getDefaultTaskStartToCloseTimeout()
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.
- Returns:
- 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.
-
withDefaultTaskStartToCloseTimeout
public RegisterActivityTypeRequest withDefaultTaskStartToCloseTimeout(String 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.
- Parameters:
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 theScheduleActivityTask
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:
- Returns a reference to this object so that method calls can be chained together.
-
setDefaultTaskHeartbeatTimeout
public 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. 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 anUnknownResource
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
- 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 theScheduleActivityTask
decision. If the activity worker subsequently attempts to record a heartbeat or returns a result, the activity worker receives anUnknownResource
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.
-
getDefaultTaskHeartbeatTimeout
public 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. 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 anUnknownResource
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:
- 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 anUnknownResource
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.
-
withDefaultTaskHeartbeatTimeout
public 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. 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 anUnknownResource
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
- 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 theScheduleActivityTask
decision. If the activity worker subsequently attempts to record a heartbeat or returns a result, the activity worker receives anUnknownResource
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:
- Returns a reference to this object so that method calls can be chained together.
-
setDefaultTaskList
public void setDefaultTaskList(TaskList 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.- Parameters:
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 theScheduleActivityTask
decision.
-
getDefaultTaskList
public TaskList getDefaultTaskList()
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.- Returns:
- 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.
-
withDefaultTaskList
public RegisterActivityTypeRequest withDefaultTaskList(TaskList 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.- Parameters:
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 theScheduleActivityTask
decision.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setDefaultTaskPriority
public void setDefaultTaskPriority(String 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) toInteger.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
- 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'sInteger.MIN_VALUE
(-2147483648) toInteger.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.
-
getDefaultTaskPriority
public String getDefaultTaskPriority()
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) toInteger.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:
- 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) toInteger.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.
-
withDefaultTaskPriority
public RegisterActivityTypeRequest withDefaultTaskPriority(String 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) toInteger.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
- 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'sInteger.MIN_VALUE
(-2147483648) toInteger.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.
-
setDefaultTaskScheduleToStartTimeout
public 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. 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.
- Parameters:
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 theScheduleActivityTask
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.
-
getDefaultTaskScheduleToStartTimeout
public String getDefaultTaskScheduleToStartTimeout()
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.
- Returns:
- 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.
-
withDefaultTaskScheduleToStartTimeout
public 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. 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.
- Parameters:
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 theScheduleActivityTask
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:
- Returns a reference to this object so that method calls can be chained together.
-
setDefaultTaskScheduleToCloseTimeout
public void setDefaultTaskScheduleToCloseTimeout(String 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.
- Parameters:
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 theScheduleActivityTask
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.
-
getDefaultTaskScheduleToCloseTimeout
public String getDefaultTaskScheduleToCloseTimeout()
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.
- Returns:
- 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.
-
withDefaultTaskScheduleToCloseTimeout
public RegisterActivityTypeRequest withDefaultTaskScheduleToCloseTimeout(String 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.
- Parameters:
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 theScheduleActivityTask
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:
- Returns a reference to this 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 classObject
- Returns:
- A string representation of this object.
- See Also:
Object.toString()
-
clone
public RegisterActivityTypeRequest clone()
Description copied from class:AmazonWebServiceRequest
Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.- Overrides:
clone
in classAmazonWebServiceRequest
- See Also:
Object.clone()
-
-