com.amazonaws.services.simpleworkflow.model
Class RegisterActivityTypeRequest

java.lang.Object
  com.amazonaws.AmazonWebServiceRequest
      com.amazonaws.services.simpleworkflow.model.RegisterActivityTypeRequest

All Implemented Interfaces:

Serializable

public class RegisterActivityTypeRequest
extends AmazonWebServiceRequest
implements Serializable

Container for the parameters to the 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:

• Use a Resource element with the domain name to limit the action to only specified domains.
• Use an Action element to allow or deny permission to call this action.
• Constrain the following parameters by using a Condition element with the appropriate keys.
  • defaultTaskList : 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 by throwing OperationNotPermitted . For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows .

See Also:

AmazonSimpleWorkflow.registerActivityType(RegisterActivityTypeRequest), Serialized Form

Constructor Summary

RegisterActivityTypeRequest()

Method Summary

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

copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, setRequestCredentials

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

RegisterActivityTypeRequest

public RegisterActivityTypeRequest()

Method Detail

getDomain

public String getDomain()

The name of the domain in which this activity is to be registered.

Constraints:
Length: 1 - 256

Returns:

The name of the domain in which this activity is to be registered.

setDomain

public void setDomain(String domain)

The name of the domain in which this activity is to be registered.

Constraints:
Length: 1 - 256

Parameters:

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

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

Constraints:
Length: 1 - 256

Parameters:

domain - The name of the domain in which this activity is to be registered.

Returns:

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

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

Constraints:
Length: 1 - 256

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

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

Constraints:
Length: 1 - 256

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

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

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

Constraints:
Length: 1 - 256

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

Returns:

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

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

Constraints:
Length: 1 - 64

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

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

Constraints:
Length: 1 - 64

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

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

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

Constraints:
Length: 1 - 64

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

Returns:

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

getDescription

public String getDescription()

A textual description of the activity type.

Constraints:
Length: 0 - 1024

Returns:

A textual description of the activity type.

setDescription

public void setDescription(String description)

A textual description of the activity type.

Constraints:
Length: 0 - 1024

Parameters:

description - A textual description of the activity type.

withDescription

public RegisterActivityTypeRequest withDescription(String description)

A textual description of the activity type.

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

Constraints:
Length: 0 - 1024

Parameters:

description - A textual description of the activity type.

Returns:

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

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

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 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:

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

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 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:

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

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

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 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 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:

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

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 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 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:

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

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.

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

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

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 the ScheduleActivityTask Decision.

Returns:

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

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

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 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:

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

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 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:

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

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

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 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:

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

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 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:

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