com.amazonaws.services.simpleworkflow.model

Class RegisterActivityTypeRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.simpleworkflow.model.RegisterActivityTypeRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class RegisterActivityTypeRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
RegisterActivityTypeRequest()

Method Summary

Modifier and Type	Method and Description
RegisterActivityTypeRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
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.
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

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

RegisterActivityTypeRequest

public RegisterActivityTypeRequest()

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 contain a : (colon), / (slash), | (vertical bar), or any control characters (- | -Ÿ). Also, it must not be the literal string arn.

Parameters:

name - The name of the activity type within the domain.

The specified string must not contain a : (colon), / (slash), | (vertical bar), or any control characters (- | -Ÿ). Also, it must not be the literal string arn.

getName

public String getName()

The name of the activity type within the domain.

The specified string must not contain a : (colon), / (slash), | (vertical bar), or any control characters (- | -Ÿ). Also, it must not be the literal string arn.

Returns:

The name of the activity type within the domain.

The specified string must not contain a : (colon), / (slash), | (vertical bar), or any control characters (- | -Ÿ). Also, it must not be the literal string arn.

withName

public RegisterActivityTypeRequest withName(String name)

The name of the activity type within the domain.

The specified string must not contain a : (colon), / (slash), | (vertical bar), or any control characters (- | -Ÿ). Also, it must not be the literal string arn.

Parameters:

name - The name of the activity type within the domain.

The specified string must not contain a : (colon), / (slash), | (vertical bar), or any control characters (- | -Ÿ). Also, it must not be the literal string arn.

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 contain a : (colon), / (slash), | (vertical bar), or any control characters (- | -Ÿ). Also, it must not be the literal string arn.

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 contain a : (colon), / (slash), | (vertical bar), or any control characters (- | -Ÿ). Also, it must not be the literal string arn.

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 contain a : (colon), / (slash), | (vertical bar), or any control characters (- | -Ÿ). Also, it must not be the literal string arn.

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 contain a : (colon), / (slash), | (vertical bar), or any control characters (- | -Ÿ). Also, it must not be 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 contain a : (colon), / (slash), | (vertical bar), or any control characters (- | -Ÿ). Also, it must not be the literal string arn.

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 contain a : (colon), / (slash), | (vertical bar), or any control characters (- | -Ÿ). Also, it must not be the literal string arn.

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. You can use NONE 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 the ScheduleActivityTask Decision.

The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE 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. You can use NONE 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. You can use NONE 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. You can use NONE 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 the ScheduleActivityTask Decision.

The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE 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 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. You can use NONE 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 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. You can use NONE 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 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. You can use NONE 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 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. You can use NONE 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 duration is specified in seconds, an integer greater than or equal to 0. You can use NONE 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 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. You can use NONE 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 isn't 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 isn't provided when a task is scheduled through the ScheduleActivityTask 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 isn't 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 isn't 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 isn't 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 isn't provided when a task is scheduled through the ScheduleActivityTask 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 is 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 in the Amazon SWF Developer Guide..

Parameters:

defaultTaskPriority - The default task priority to assign to the activity type. If not assigned, then 0 is 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 in the Amazon SWF Developer Guide..

getDefaultTaskPriority

public String getDefaultTaskPriority()

The default task priority to assign to the activity type. If not assigned, then 0 is 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 in the Amazon SWF Developer Guide..

Returns:

The default task priority to assign to the activity type. If not assigned, then 0 is 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 in the Amazon SWF Developer Guide..

withDefaultTaskPriority

public RegisterActivityTypeRequest withDefaultTaskPriority(String defaultTaskPriority)

The default task priority to assign to the activity type. If not assigned, then 0 is 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 in the Amazon SWF Developer Guide..

Parameters:

defaultTaskPriority - The default task priority to assign to the activity type. If not assigned, then 0 is 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 in the Amazon SWF 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. You can use NONE 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 the ScheduleActivityTask Decision.

The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE 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. You can use NONE 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. You can use NONE 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. You can use NONE 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 the ScheduleActivityTask Decision.

The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE 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. You can use NONE 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 the ScheduleActivityTask Decision.

The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE 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. You can use NONE 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. You can use NONE 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. You can use NONE 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 the ScheduleActivityTask Decision.

The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE 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. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public RegisterActivityTypeRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()