public class RegisterWorkflowTypeRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
RegisterWorkflowType operation
.
Registers a new workflow type and its configuration settings in the specified domain.
The retention period for the workflow history is set by the RegisterDomain action.
IMPORTANT:If the type already exists, then a TypeAlreadyExists fault is returned. You cannot change the configuration settings of a workflow type once it is registered and it must be registered as a new version.
Access Control
You can use IAM policies to control this action's access to Amazon SWF resources as follows:
Resource
element with the domain name to limit
the action to only specified domains.Action
element to allow or deny permission to
call this action.Condition
element with the appropriate keys.
defaultTaskList.name
: String constraint. The key
is swf:defaultTaskList.name
.name
: String constraint. The key is
swf:name
.version
: String constraint. The key is
swf:version
.If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows .
NOOP
Constructor and Description |
---|
RegisterWorkflowTypeRequest() |
Modifier and Type | Method and Description |
---|---|
RegisterWorkflowTypeRequest |
clone()
Creates a shallow clone of this request.
|
boolean |
equals(Object obj) |
String |
getDefaultChildPolicy()
If set, specifies the default policy to use for the child workflow
executions when a workflow execution of this type is terminated, by
calling the TerminateWorkflowExecution action explicitly or due
to an expired timeout.
|
String |
getDefaultExecutionStartToCloseTimeout()
If set, specifies the default maximum duration for executions of this
workflow type.
|
String |
getDefaultLambdaRole()
The ARN of the default IAM role to use when a workflow execution of
this type invokes AWS Lambda functions.
|
TaskList |
getDefaultTaskList()
If set, specifies the default task list to use for scheduling decision
tasks for executions of this workflow type.
|
String |
getDefaultTaskPriority()
The default task priority to assign to the workflow type.
|
String |
getDefaultTaskStartToCloseTimeout()
If set, specifies the default maximum duration of decision tasks for
this workflow type.
|
String |
getDescription()
Textual description of the workflow type.
|
String |
getDomain()
The name of the domain in which to register the workflow type.
|
String |
getName()
The name of the workflow type.
|
String |
getVersion()
The version of the workflow type.
|
int |
hashCode() |
void |
setDefaultChildPolicy(ChildPolicy defaultChildPolicy)
If set, specifies the default policy to use for the child workflow
executions when a workflow execution of this type is terminated, by
calling the TerminateWorkflowExecution action explicitly or due
to an expired timeout.
|
void |
setDefaultChildPolicy(String defaultChildPolicy)
If set, specifies the default policy to use for the child workflow
executions when a workflow execution of this type is terminated, by
calling the TerminateWorkflowExecution action explicitly or due
to an expired timeout.
|
void |
setDefaultExecutionStartToCloseTimeout(String defaultExecutionStartToCloseTimeout)
If set, specifies the default maximum duration for executions of this
workflow type.
|
void |
setDefaultLambdaRole(String defaultLambdaRole)
The ARN of the default IAM role to use when a workflow execution of
this type invokes AWS Lambda functions.
|
void |
setDefaultTaskList(TaskList defaultTaskList)
If set, specifies the default task list to use for scheduling decision
tasks for executions of this workflow type.
|
void |
setDefaultTaskPriority(String defaultTaskPriority)
The default task priority to assign to the workflow type.
|
void |
setDefaultTaskStartToCloseTimeout(String defaultTaskStartToCloseTimeout)
If set, specifies the default maximum duration of decision tasks for
this workflow type.
|
void |
setDescription(String description)
Textual description of the workflow type.
|
void |
setDomain(String domain)
The name of the domain in which to register the workflow type.
|
void |
setName(String name)
The name of the workflow type.
|
void |
setVersion(String version)
The version of the workflow type.
|
String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
RegisterWorkflowTypeRequest |
withDefaultChildPolicy(ChildPolicy defaultChildPolicy)
If set, specifies the default policy to use for the child workflow
executions when a workflow execution of this type is terminated, by
calling the TerminateWorkflowExecution action explicitly or due
to an expired timeout.
|
RegisterWorkflowTypeRequest |
withDefaultChildPolicy(String defaultChildPolicy)
If set, specifies the default policy to use for the child workflow
executions when a workflow execution of this type is terminated, by
calling the TerminateWorkflowExecution action explicitly or due
to an expired timeout.
|
RegisterWorkflowTypeRequest |
withDefaultExecutionStartToCloseTimeout(String defaultExecutionStartToCloseTimeout)
If set, specifies the default maximum duration for executions of this
workflow type.
|
RegisterWorkflowTypeRequest |
withDefaultLambdaRole(String defaultLambdaRole)
The ARN of the default IAM role to use when a workflow execution of
this type invokes AWS Lambda functions.
|
RegisterWorkflowTypeRequest |
withDefaultTaskList(TaskList defaultTaskList)
If set, specifies the default task list to use for scheduling decision
tasks for executions of this workflow type.
|
RegisterWorkflowTypeRequest |
withDefaultTaskPriority(String defaultTaskPriority)
The default task priority to assign to the workflow type.
|
RegisterWorkflowTypeRequest |
withDefaultTaskStartToCloseTimeout(String defaultTaskStartToCloseTimeout)
If set, specifies the default maximum duration of decision tasks for
this workflow type.
|
RegisterWorkflowTypeRequest |
withDescription(String description)
Textual description of the workflow type.
|
RegisterWorkflowTypeRequest |
withDomain(String domain)
The name of the domain in which to register the workflow type.
|
RegisterWorkflowTypeRequest |
withName(String name)
The name of the workflow type.
|
RegisterWorkflowTypeRequest |
withVersion(String version)
The version of the workflow type.
|
getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
public String getDomain()
Constraints:
Length: 1 - 256
public void setDomain(String domain)
Constraints:
Length: 1 - 256
domain
- The name of the domain in which to register the workflow type.public RegisterWorkflowTypeRequest withDomain(String domain)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 256
domain
- The name of the domain in which to register the workflow type.public String getName()
The specified string must not start
or end with whitespace. It must not contain a :
(colon),
/
(slash), |
(vertical bar), or any control
characters ( - | - ). Also, it must not
contain the literal string "arn".
Constraints:
Length: 1 - 256
The specified string must not start
or end with whitespace. It must not contain a :
(colon),
/
(slash), |
(vertical bar), or any control
characters ( - | - ). Also, it must not
contain the literal string "arn".
public void setName(String name)
The specified string must not start
or end with whitespace. It must not contain a :
(colon),
/
(slash), |
(vertical bar), or any control
characters ( - | - ). Also, it must not
contain the literal string "arn".
Constraints:
Length: 1 - 256
name
- The name of the workflow type. The specified string must not start
or end with whitespace. It must not contain a :
(colon),
/
(slash), |
(vertical bar), or any control
characters ( - | - ). Also, it must not
contain the literal string "arn".
public RegisterWorkflowTypeRequest withName(String name)
The specified string must not start
or end with whitespace. It must not contain a :
(colon),
/
(slash), |
(vertical bar), or any control
characters ( - | - ). Also, it must not
contain the literal string "arn".
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 256
name
- The name of the workflow type. The specified string must not start
or end with whitespace. It must not contain a :
(colon),
/
(slash), |
(vertical bar), or any control
characters ( - | - ). Also, it must not
contain the literal string "arn".
public String getVersion()
The specified
string must not start or end with whitespace. It must not contain a
:
(colon), /
(slash), |
(vertical bar), or any control characters ( - | -
). Also, it must not contain the literal string "arn".
Constraints:
Length: 1 - 64
The specified
string must not start or end with whitespace. It must not contain a
:
(colon), /
(slash), |
(vertical bar), or any control characters ( - | -
). Also, it must not contain the literal string "arn".
public void setVersion(String version)
The specified
string must not start or end with whitespace. It must not contain a
:
(colon), /
(slash), |
(vertical bar), or any control characters ( - | -
). Also, it must not contain the literal string "arn".
Constraints:
Length: 1 - 64
version
- The version of the workflow type. The specified
string must not start or end with whitespace. It must not contain a
:
(colon), /
(slash), |
(vertical bar), or any control characters ( - | -
). Also, it must not contain the literal string "arn".
public RegisterWorkflowTypeRequest withVersion(String version)
The specified
string must not start or end with whitespace. It must not contain a
:
(colon), /
(slash), |
(vertical bar), or any control characters ( - | -
). Also, it must not contain the literal string "arn".
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 64
version
- The version of the workflow type. The specified
string must not start or end with whitespace. It must not contain a
:
(colon), /
(slash), |
(vertical bar), or any control characters ( - | -
). Also, it must not contain the literal string "arn".
public String getDescription()
Constraints:
Length: 0 - 1024
public void setDescription(String description)
Constraints:
Length: 0 - 1024
description
- Textual description of the workflow type.public RegisterWorkflowTypeRequest withDescription(String description)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 0 - 1024
description
- Textual description of the workflow type.public String getDefaultTaskStartToCloseTimeout()
StartChildWorkflowExecution
decision. The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.
Constraints:
Length: 0 - 8
StartChildWorkflowExecution
decision. The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.
public void setDefaultTaskStartToCloseTimeout(String defaultTaskStartToCloseTimeout)
StartChildWorkflowExecution
decision. The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.
Constraints:
Length: 0 - 8
defaultTaskStartToCloseTimeout
- If set, specifies the default maximum duration of decision tasks for
this workflow type. This default can be overridden when starting a
workflow execution using the StartWorkflowExecution action or
the StartChildWorkflowExecution
decision. The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.
public RegisterWorkflowTypeRequest withDefaultTaskStartToCloseTimeout(String defaultTaskStartToCloseTimeout)
StartChildWorkflowExecution
decision. The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 0 - 8
defaultTaskStartToCloseTimeout
- If set, specifies the default maximum duration of decision tasks for
this workflow type. This default can be overridden when starting a
workflow execution using the StartWorkflowExecution action or
the StartChildWorkflowExecution
decision. The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.
public String getDefaultExecutionStartToCloseTimeout()
StartChildWorkflowExecution
decision. The duration is
specified in seconds; an integer greater than or equal to 0. Unlike
some of the other timeout parameters in Amazon SWF, you cannot specify
a value of "NONE" for
defaultExecutionStartToCloseTimeout
; there is a one-year
max limit on the time that a workflow execution can run. Exceeding
this limit will always cause the workflow execution to time out.
Constraints:
Length: 0 - 8
StartChildWorkflowExecution
decision. The duration is
specified in seconds; an integer greater than or equal to 0. Unlike
some of the other timeout parameters in Amazon SWF, you cannot specify
a value of "NONE" for
defaultExecutionStartToCloseTimeout
; there is a one-year
max limit on the time that a workflow execution can run. Exceeding
this limit will always cause the workflow execution to time out.
public void setDefaultExecutionStartToCloseTimeout(String defaultExecutionStartToCloseTimeout)
StartChildWorkflowExecution
decision. The duration is
specified in seconds; an integer greater than or equal to 0. Unlike
some of the other timeout parameters in Amazon SWF, you cannot specify
a value of "NONE" for
defaultExecutionStartToCloseTimeout
; there is a one-year
max limit on the time that a workflow execution can run. Exceeding
this limit will always cause the workflow execution to time out.
Constraints:
Length: 0 - 8
defaultExecutionStartToCloseTimeout
- If set, specifies the default maximum duration for executions of this
workflow type. You can override this default when starting an
execution through the StartWorkflowExecution action or
StartChildWorkflowExecution
decision. The duration is
specified in seconds; an integer greater than or equal to 0. Unlike
some of the other timeout parameters in Amazon SWF, you cannot specify
a value of "NONE" for
defaultExecutionStartToCloseTimeout
; there is a one-year
max limit on the time that a workflow execution can run. Exceeding
this limit will always cause the workflow execution to time out.
public RegisterWorkflowTypeRequest withDefaultExecutionStartToCloseTimeout(String defaultExecutionStartToCloseTimeout)
StartChildWorkflowExecution
decision. The duration is
specified in seconds; an integer greater than or equal to 0. Unlike
some of the other timeout parameters in Amazon SWF, you cannot specify
a value of "NONE" for
defaultExecutionStartToCloseTimeout
; there is a one-year
max limit on the time that a workflow execution can run. Exceeding
this limit will always cause the workflow execution to time out.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 0 - 8
defaultExecutionStartToCloseTimeout
- If set, specifies the default maximum duration for executions of this
workflow type. You can override this default when starting an
execution through the StartWorkflowExecution action or
StartChildWorkflowExecution
decision. The duration is
specified in seconds; an integer greater than or equal to 0. Unlike
some of the other timeout parameters in Amazon SWF, you cannot specify
a value of "NONE" for
defaultExecutionStartToCloseTimeout
; there is a one-year
max limit on the time that a workflow execution can run. Exceeding
this limit will always cause the workflow execution to time out.
public TaskList getDefaultTaskList()
StartChildWorkflowExecution
decision.StartChildWorkflowExecution
decision.public void setDefaultTaskList(TaskList defaultTaskList)
StartChildWorkflowExecution
decision.defaultTaskList
- If set, specifies the default task list to use for scheduling decision
tasks for executions of this workflow type. This default is used only
if a task list is not provided when starting the execution through the
StartWorkflowExecution action or
StartChildWorkflowExecution
decision.public RegisterWorkflowTypeRequest withDefaultTaskList(TaskList defaultTaskList)
StartChildWorkflowExecution
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 decision
tasks for executions of this workflow type. This default is used only
if a task list is not provided when starting the execution through the
StartWorkflowExecution action or
StartChildWorkflowExecution
decision.public String getDefaultTaskPriority()
Integer.MIN_VALUE
(-2147483648) to
Integer.MAX_VALUE
(2147483647). Higher numbers indicate
higher priority. For more information about setting task priority, see Setting Task Priority in the Amazon Simple Workflow Developer Guide.
Constraints:
Length: 0 - 11
Integer.MIN_VALUE
(-2147483648) to
Integer.MAX_VALUE
(2147483647). Higher numbers indicate
higher priority. For more information about setting task priority, see Setting Task Priority in the Amazon Simple Workflow Developer Guide.
public void setDefaultTaskPriority(String defaultTaskPriority)
Integer.MIN_VALUE
(-2147483648) to
Integer.MAX_VALUE
(2147483647). Higher numbers indicate
higher priority. For more information about setting task priority, see Setting Task Priority in the Amazon Simple Workflow Developer Guide.
Constraints:
Length: 0 - 11
defaultTaskPriority
- The default task priority to assign to the workflow type. If not
assigned, then "0" will be used. Valid values are integers that range
from Java's Integer.MIN_VALUE
(-2147483648) to
Integer.MAX_VALUE
(2147483647). Higher numbers indicate
higher priority. For more information about setting task priority, see Setting Task Priority in the Amazon Simple Workflow Developer Guide.
public RegisterWorkflowTypeRequest withDefaultTaskPriority(String defaultTaskPriority)
Integer.MIN_VALUE
(-2147483648) to
Integer.MAX_VALUE
(2147483647). Higher numbers indicate
higher priority. For more information about setting task priority, see Setting Task Priority in the Amazon Simple Workflow Developer Guide.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 0 - 11
defaultTaskPriority
- The default task priority to assign to the workflow type. If not
assigned, then "0" will be used. Valid values are integers that range
from Java's Integer.MIN_VALUE
(-2147483648) to
Integer.MAX_VALUE
(2147483647). Higher numbers indicate
higher priority. For more information about setting task priority, see Setting Task Priority in the Amazon Simple Workflow Developer Guide.
public String getDefaultChildPolicy()
StartChildWorkflowExecution
decision. The supported child policies are:
WorkflowExecutionCancelRequested
event in its
history. It is up to the decider to take appropriate actions when it
receives an execution history with this event.
Constraints:
Allowed Values: TERMINATE, REQUEST_CANCEL, ABANDON
StartChildWorkflowExecution
decision. The supported child policies are:
WorkflowExecutionCancelRequested
event in its
history. It is up to the decider to take appropriate actions when it
receives an execution history with this event.ChildPolicy
public void setDefaultChildPolicy(String defaultChildPolicy)
StartChildWorkflowExecution
decision. The supported child policies are:
WorkflowExecutionCancelRequested
event in its
history. It is up to the decider to take appropriate actions when it
receives an execution history with this event.
Constraints:
Allowed Values: TERMINATE, REQUEST_CANCEL, ABANDON
defaultChildPolicy
- If set, specifies the default policy to use for the child workflow
executions when a workflow execution of this type is terminated, by
calling the TerminateWorkflowExecution action explicitly or due
to an expired timeout. This default can be overridden when starting a
workflow execution using the StartWorkflowExecution action or
the StartChildWorkflowExecution
decision. The supported child policies are:
WorkflowExecutionCancelRequested
event in its
history. It is up to the decider to take appropriate actions when it
receives an execution history with this event.ChildPolicy
public RegisterWorkflowTypeRequest withDefaultChildPolicy(String defaultChildPolicy)
StartChildWorkflowExecution
decision. The supported child policies are:
WorkflowExecutionCancelRequested
event in its
history. It is up to the decider to take appropriate actions when it
receives an execution history with this event.Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: TERMINATE, REQUEST_CANCEL, ABANDON
defaultChildPolicy
- If set, specifies the default policy to use for the child workflow
executions when a workflow execution of this type is terminated, by
calling the TerminateWorkflowExecution action explicitly or due
to an expired timeout. This default can be overridden when starting a
workflow execution using the StartWorkflowExecution action or
the StartChildWorkflowExecution
decision. The supported child policies are:
WorkflowExecutionCancelRequested
event in its
history. It is up to the decider to take appropriate actions when it
receives an execution history with this event.ChildPolicy
public void setDefaultChildPolicy(ChildPolicy defaultChildPolicy)
StartChildWorkflowExecution
decision. The supported child policies are:
WorkflowExecutionCancelRequested
event in its
history. It is up to the decider to take appropriate actions when it
receives an execution history with this event.
Constraints:
Allowed Values: TERMINATE, REQUEST_CANCEL, ABANDON
defaultChildPolicy
- If set, specifies the default policy to use for the child workflow
executions when a workflow execution of this type is terminated, by
calling the TerminateWorkflowExecution action explicitly or due
to an expired timeout. This default can be overridden when starting a
workflow execution using the StartWorkflowExecution action or
the StartChildWorkflowExecution
decision. The supported child policies are:
WorkflowExecutionCancelRequested
event in its
history. It is up to the decider to take appropriate actions when it
receives an execution history with this event.ChildPolicy
public RegisterWorkflowTypeRequest withDefaultChildPolicy(ChildPolicy defaultChildPolicy)
StartChildWorkflowExecution
decision. The supported child policies are:
WorkflowExecutionCancelRequested
event in its
history. It is up to the decider to take appropriate actions when it
receives an execution history with this event.Returns a reference to this object so that method calls can be chained together.
Constraints:
Allowed Values: TERMINATE, REQUEST_CANCEL, ABANDON
defaultChildPolicy
- If set, specifies the default policy to use for the child workflow
executions when a workflow execution of this type is terminated, by
calling the TerminateWorkflowExecution action explicitly or due
to an expired timeout. This default can be overridden when starting a
workflow execution using the StartWorkflowExecution action or
the StartChildWorkflowExecution
decision. The supported child policies are:
WorkflowExecutionCancelRequested
event in its
history. It is up to the decider to take appropriate actions when it
receives an execution history with this event.ChildPolicy
public String getDefaultLambdaRole()
This default can be
overridden when starting a workflow execution using the
StartWorkflowExecution action or the
StartChildWorkflowExecution
and
ContinueAsNewWorkflowExecution
decision.
Constraints:
Length: 1 - 1224
This default can be
overridden when starting a workflow execution using the
StartWorkflowExecution action or the
StartChildWorkflowExecution
and
ContinueAsNewWorkflowExecution
decision.
public void setDefaultLambdaRole(String defaultLambdaRole)
This default can be
overridden when starting a workflow execution using the
StartWorkflowExecution action or the
StartChildWorkflowExecution
and
ContinueAsNewWorkflowExecution
decision.
Constraints:
Length: 1 - 1224
defaultLambdaRole
- The ARN of the default IAM role to use when a workflow execution of
this type invokes AWS Lambda functions. This default can be
overridden when starting a workflow execution using the
StartWorkflowExecution action or the
StartChildWorkflowExecution
and
ContinueAsNewWorkflowExecution
decision.
public RegisterWorkflowTypeRequest withDefaultLambdaRole(String defaultLambdaRole)
This default can be
overridden when starting a workflow execution using the
StartWorkflowExecution action or the
StartChildWorkflowExecution
and
ContinueAsNewWorkflowExecution
decision.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 1224
defaultLambdaRole
- The ARN of the default IAM role to use when a workflow execution of
this type invokes AWS Lambda functions. This default can be
overridden when starting a workflow execution using the
StartWorkflowExecution action or the
StartChildWorkflowExecution
and
ContinueAsNewWorkflowExecution
decision.
public String toString()
toString
in class Object
Object.toString()
public RegisterWorkflowTypeRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()
Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.