com.amazonaws.services.simpleworkflow.model

クラス RegisterActivityTypeRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.simpleworkflow.model.RegisterActivityTypeRequest

すべての実装されたインタフェース:

java.io.Serializable

public class RegisterActivityTypeRequest
extends AmazonWebServiceRequest
implements java.io.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 .

関連項目:

AmazonSimpleWorkflow.registerActivityType(RegisterActivityTypeRequest), 直列化された形式

コンストラクタの概要

コンストラクタ

コンストラクタと説明
RegisterActivityTypeRequest()

メソッドの概要

メソッド

修飾子とタイプ	メソッドと説明
boolean	equals(java.lang.Object obj)
java.lang.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.
java.lang.String	getDefaultTaskScheduleToCloseTimeout() If set, specifies the default maximum duration for a task of this activity type.
java.lang.String	getDefaultTaskScheduleToStartTimeout() If set, specifies the default maximum duration that a task of this activity type can wait before being assigned to a worker.
java.lang.String	getDefaultTaskStartToCloseTimeout() If set, specifies the default maximum duration that a worker can take to process tasks of this activity type.
java.lang.String	getDescription() A textual description of the activity type.
java.lang.String	getDomain() The name of the domain in which this activity is to be registered.
java.lang.String	getName() The name of the activity type within the domain.
java.lang.String	getVersion() The version of the activity type.
int	hashCode()
void	setDefaultTaskHeartbeatTimeout(java.lang.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(java.lang.String defaultTaskScheduleToCloseTimeout) If set, specifies the default maximum duration for a task of this activity type.
void	setDefaultTaskScheduleToStartTimeout(java.lang.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(java.lang.String defaultTaskStartToCloseTimeout) If set, specifies the default maximum duration that a worker can take to process tasks of this activity type.
void	setDescription(java.lang.String description) A textual description of the activity type.
void	setDomain(java.lang.String domain) The name of the domain in which this activity is to be registered.
void	setName(java.lang.String name) The name of the activity type within the domain.
void	setVersion(java.lang.String version) The version of the activity type.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
RegisterActivityTypeRequest	withDefaultTaskHeartbeatTimeout(java.lang.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(java.lang.String defaultTaskScheduleToCloseTimeout) If set, specifies the default maximum duration for a task of this activity type.
RegisterActivityTypeRequest	withDefaultTaskScheduleToStartTimeout(java.lang.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(java.lang.String defaultTaskStartToCloseTimeout) If set, specifies the default maximum duration that a worker can take to process tasks of this activity type.
RegisterActivityTypeRequest	withDescription(java.lang.String description) A textual description of the activity type.
RegisterActivityTypeRequest	withDomain(java.lang.String domain) The name of the domain in which this activity is to be registered.
RegisterActivityTypeRequest	withName(java.lang.String name) The name of the activity type within the domain.
RegisterActivityTypeRequest	withVersion(java.lang.String version) The version of the activity type.

クラスから継承されたメソッド com.amazonaws.AmazonWebServiceRequest

copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, setRequestCredentials

クラスから継承されたメソッド java.lang.Object

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

コンストラクタの詳細

RegisterActivityTypeRequest

public RegisterActivityTypeRequest()

メソッドの詳細

getDomain

public java.lang.String getDomain()

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

Constraints:
Length: 1 - 256

戻り値:

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

setDomain

public void setDomain(java.lang.String domain)

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

Constraints:
Length: 1 - 256

パラメータ:

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

withDomain

public RegisterActivityTypeRequest withDomain(java.lang.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

パラメータ:

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

getName

public java.lang.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

戻り値:

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(java.lang.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

パラメータ:

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(java.lang.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

パラメータ:

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

getVersion

public java.lang.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

戻り値:

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(java.lang.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

パラメータ:

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(java.lang.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

パラメータ:

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

getDescription

public java.lang.String getDescription()

A textual description of the activity type.

Constraints:
Length: 0 - 1024

戻り値:

A textual description of the activity type.

setDescription

public void setDescription(java.lang.String description)

A textual description of the activity type.

Constraints:
Length: 0 - 1024

パラメータ:

description - A textual description of the activity type.

withDescription

public RegisterActivityTypeRequest withDescription(java.lang.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

パラメータ:

description - A textual description of the activity type.

getDefaultTaskStartToCloseTimeout

public java.lang.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

戻り値:

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(java.lang.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

パラメータ:

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(java.lang.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

パラメータ:

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.

getDefaultTaskHeartbeatTimeout

public java.lang.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

戻り値:

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(java.lang.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

パラメータ:

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(java.lang.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

パラメータ:

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.

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.

戻り値:

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.

パラメータ:

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.

パラメータ:

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.

getDefaultTaskScheduleToStartTimeout

public java.lang.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

戻り値:

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(java.lang.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

パラメータ:

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(java.lang.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

パラメータ:

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.

getDefaultTaskScheduleToCloseTimeout

public java.lang.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

戻り値:

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(java.lang.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

パラメータ:

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(java.lang.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

パラメータ:

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.

toString

public java.lang.String toString()

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

オーバーライド:

toString クラス内 java.lang.Object

戻り値:

A string representation of this object.

関連項目:

Object.toString()

hashCode

public int hashCode()

オーバーライド:

hashCode クラス内 java.lang.Object

equals

public boolean equals(java.lang.Object obj)

オーバーライド:

equals クラス内 java.lang.Object