public class StartWorkflowExecutionRequest extends AmazonWebServiceRequest implements Serializable
StartWorkflowExecution operation
.
Starts an execution of the workflow type in the specified domain
using the provided workflowId
and input data.
This action returns the newly started workflow execution.
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.
tagList.member.0
: The key is
swf:tagList.member.0
.tagList.member.1
: The key is
swf:tagList.member.1
.tagList.member.2
: The key is
swf:tagList.member.2
.tagList.member.3
: The key is
swf:tagList.member.3
.tagList.member.4
: The key is
swf:tagList.member.4
.taskList
: String constraint. The key is
swf:taskList.name
.name
: String constraint. The key is
swf:workflowType.name
.version
: String constraint. The key is
swf:workflowType.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
.
NOOP
Constructor and Description |
---|
StartWorkflowExecutionRequest() |
Modifier and Type | Method and Description |
---|---|
boolean |
equals(Object obj) |
String |
getChildPolicy()
If set, specifies the policy to use for the child workflow executions
of this workflow execution if it is terminated, by calling the
TerminateWorkflowExecution action explicitly or due to an
expired timeout.
|
String |
getDomain()
The name of the domain in which the workflow execution is created.
|
String |
getExecutionStartToCloseTimeout()
The total duration for this workflow execution.
|
String |
getInput()
The input for the workflow execution.
|
List<String> |
getTagList()
The list of tags to associate with the workflow execution.
|
TaskList |
getTaskList()
The task list to use for the decision tasks generated for this
workflow execution.
|
String |
getTaskStartToCloseTimeout()
Specifies the maximum duration of decision tasks for this workflow
execution.
|
String |
getWorkflowId()
The user defined identifier associated with the workflow execution.
|
WorkflowType |
getWorkflowType()
The type of the workflow to start.
|
int |
hashCode() |
void |
setChildPolicy(ChildPolicy childPolicy)
If set, specifies the policy to use for the child workflow executions
of this workflow execution if it is terminated, by calling the
TerminateWorkflowExecution action explicitly or due to an
expired timeout.
|
void |
setChildPolicy(String childPolicy)
If set, specifies the policy to use for the child workflow executions
of this workflow execution if it is terminated, by calling the
TerminateWorkflowExecution action explicitly or due to an
expired timeout.
|
void |
setDomain(String domain)
The name of the domain in which the workflow execution is created.
|
void |
setExecutionStartToCloseTimeout(String executionStartToCloseTimeout)
The total duration for this workflow execution.
|
void |
setInput(String input)
The input for the workflow execution.
|
void |
setTagList(Collection<String> tagList)
The list of tags to associate with the workflow execution.
|
void |
setTaskList(TaskList taskList)
The task list to use for the decision tasks generated for this
workflow execution.
|
void |
setTaskStartToCloseTimeout(String taskStartToCloseTimeout)
Specifies the maximum duration of decision tasks for this workflow
execution.
|
void |
setWorkflowId(String workflowId)
The user defined identifier associated with the workflow execution.
|
void |
setWorkflowType(WorkflowType workflowType)
The type of the workflow to start.
|
String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
StartWorkflowExecutionRequest |
withChildPolicy(ChildPolicy childPolicy)
If set, specifies the policy to use for the child workflow executions
of this workflow execution if it is terminated, by calling the
TerminateWorkflowExecution action explicitly or due to an
expired timeout.
|
StartWorkflowExecutionRequest |
withChildPolicy(String childPolicy)
If set, specifies the policy to use for the child workflow executions
of this workflow execution if it is terminated, by calling the
TerminateWorkflowExecution action explicitly or due to an
expired timeout.
|
StartWorkflowExecutionRequest |
withDomain(String domain)
The name of the domain in which the workflow execution is created.
|
StartWorkflowExecutionRequest |
withExecutionStartToCloseTimeout(String executionStartToCloseTimeout)
The total duration for this workflow execution.
|
StartWorkflowExecutionRequest |
withInput(String input)
The input for the workflow execution.
|
StartWorkflowExecutionRequest |
withTagList(Collection<String> tagList)
The list of tags to associate with the workflow execution.
|
StartWorkflowExecutionRequest |
withTagList(String... tagList)
The list of tags to associate with the workflow execution.
|
StartWorkflowExecutionRequest |
withTaskList(TaskList taskList)
The task list to use for the decision tasks generated for this
workflow execution.
|
StartWorkflowExecutionRequest |
withTaskStartToCloseTimeout(String taskStartToCloseTimeout)
Specifies the maximum duration of decision tasks for this workflow
execution.
|
StartWorkflowExecutionRequest |
withWorkflowId(String workflowId)
The user defined identifier associated with the workflow execution.
|
StartWorkflowExecutionRequest |
withWorkflowType(WorkflowType workflowType)
The type of the workflow to start.
|
copyPrivateRequestParameters, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector
public String getDomain()
Constraints:
Length: 1 - 256
public void setDomain(String domain)
Constraints:
Length: 1 - 256
domain
- The name of the domain in which the workflow execution is created.public StartWorkflowExecutionRequest 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 the workflow execution is created.public String getWorkflowId()
workflowId
at
the same time. 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
workflowId
at
the same time. 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 setWorkflowId(String workflowId)
workflowId
at
the same time. 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
workflowId
- The user defined identifier associated with the workflow execution.
You can use this to associate a custom identifier with the workflow
execution. You may specify the same identifier if a workflow execution
is logically a restart of a previous execution. You cannot have
two open workflow executions with the same workflowId
at
the same time. 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 StartWorkflowExecutionRequest withWorkflowId(String workflowId)
workflowId
at
the same time. 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
workflowId
- The user defined identifier associated with the workflow execution.
You can use this to associate a custom identifier with the workflow
execution. You may specify the same identifier if a workflow execution
is logically a restart of a previous execution. You cannot have
two open workflow executions with the same workflowId
at
the same time. 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 WorkflowType getWorkflowType()
public void setWorkflowType(WorkflowType workflowType)
workflowType
- The type of the workflow to start.public StartWorkflowExecutionRequest withWorkflowType(WorkflowType workflowType)
Returns a reference to this object so that method calls can be chained together.
workflowType
- The type of the workflow to start.public TaskList getTaskList()
defaultTaskList
specified when registering 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".
defaultTaskList
specified when registering 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 void setTaskList(TaskList taskList)
defaultTaskList
specified when registering 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".
taskList
- The task list to use for the decision tasks generated for this
workflow execution. This overrides the defaultTaskList
specified when registering 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 StartWorkflowExecutionRequest withTaskList(TaskList taskList)
defaultTaskList
specified when registering 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".
Returns a reference to this object so that method calls can be chained together.
taskList
- The task list to use for the decision tasks generated for this
workflow execution. This overrides the defaultTaskList
specified when registering 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 getInput()
input
is made available to the new workflow execution in
the WorkflowExecutionStarted
history event.
Constraints:
Length: 0 - 32768
input
is made available to the new workflow execution in
the WorkflowExecutionStarted
history event.public void setInput(String input)
input
is made available to the new workflow execution in
the WorkflowExecutionStarted
history event.
Constraints:
Length: 0 - 32768
input
- The input for the workflow execution. This is a free form string which
should be meaningful to the workflow you are starting. This
input
is made available to the new workflow execution in
the WorkflowExecutionStarted
history event.public StartWorkflowExecutionRequest withInput(String input)
input
is made available to the new workflow execution in
the WorkflowExecutionStarted
history event.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 0 - 32768
input
- The input for the workflow execution. This is a free form string which
should be meaningful to the workflow you are starting. This
input
is made available to the new workflow execution in
the WorkflowExecutionStarted
history event.public String getExecutionStartToCloseTimeout()
The duration is specified in seconds. The valid
values are integers greater than or equal to 0. Exceeding this limit
will cause the workflow execution to time out. Unlike some of the
other timeout parameters in Amazon SWF, you cannot specify a value of
"NONE" for this timeout; there is a one-year max limit on the time
that a workflow execution can run.
Constraints:
Length: 0 - 8
The duration is specified in seconds. The valid
values are integers greater than or equal to 0. Exceeding this limit
will cause the workflow execution to time out. Unlike some of the
other timeout parameters in Amazon SWF, you cannot specify a value of
"NONE" for this timeout; there is a one-year max limit on the time
that a workflow execution can run.
public void setExecutionStartToCloseTimeout(String executionStartToCloseTimeout)
The duration is specified in seconds. The valid
values are integers greater than or equal to 0. Exceeding this limit
will cause the workflow execution to time out. Unlike some of the
other timeout parameters in Amazon SWF, you cannot specify a value of
"NONE" for this timeout; there is a one-year max limit on the time
that a workflow execution can run.
Constraints:
Length: 0 - 8
executionStartToCloseTimeout
- The total duration for this workflow execution. This overrides the
defaultExecutionStartToCloseTimeout specified when registering the
workflow type. The duration is specified in seconds. The valid
values are integers greater than or equal to 0. Exceeding this limit
will cause the workflow execution to time out. Unlike some of the
other timeout parameters in Amazon SWF, you cannot specify a value of
"NONE" for this timeout; there is a one-year max limit on the time
that a workflow execution can run.
public StartWorkflowExecutionRequest withExecutionStartToCloseTimeout(String executionStartToCloseTimeout)
The duration is specified in seconds. The valid
values are integers greater than or equal to 0. Exceeding this limit
will cause the workflow execution to time out. Unlike some of the
other timeout parameters in Amazon SWF, you cannot specify a value of
"NONE" for this timeout; there is a one-year max limit on the time
that a workflow execution can run.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 0 - 8
executionStartToCloseTimeout
- The total duration for this workflow execution. This overrides the
defaultExecutionStartToCloseTimeout specified when registering the
workflow type. The duration is specified in seconds. The valid
values are integers greater than or equal to 0. Exceeding this limit
will cause the workflow execution to time out. Unlike some of the
other timeout parameters in Amazon SWF, you cannot specify a value of
"NONE" for this timeout; there is a one-year max limit on the time
that a workflow execution can run.
public List<String> getTagList()
Constraints:
Length: 0 - 5
public void setTagList(Collection<String> tagList)
Constraints:
Length: 0 - 5
tagList
- The list of tags to associate with the workflow execution. You can
specify a maximum of 5 tags. You can list workflow executions with a
specific tag by calling ListOpenWorkflowExecutions or
ListClosedWorkflowExecutions and specifying a TagFilter.public StartWorkflowExecutionRequest withTagList(String... tagList)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 0 - 5
tagList
- The list of tags to associate with the workflow execution. You can
specify a maximum of 5 tags. You can list workflow executions with a
specific tag by calling ListOpenWorkflowExecutions or
ListClosedWorkflowExecutions and specifying a TagFilter.public StartWorkflowExecutionRequest withTagList(Collection<String> tagList)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 0 - 5
tagList
- The list of tags to associate with the workflow execution. You can
specify a maximum of 5 tags. You can list workflow executions with a
specific tag by calling ListOpenWorkflowExecutions or
ListClosedWorkflowExecutions and specifying a TagFilter.public String getTaskStartToCloseTimeout()
defaultTaskStartToCloseTimout
specified when registering
the workflow type using RegisterWorkflowType. 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
defaultTaskStartToCloseTimout
specified when registering
the workflow type using RegisterWorkflowType. 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.
public void setTaskStartToCloseTimeout(String taskStartToCloseTimeout)
defaultTaskStartToCloseTimout
specified when registering
the workflow type using RegisterWorkflowType. 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
taskStartToCloseTimeout
- Specifies the maximum duration of decision tasks for this workflow
execution. This parameter overrides the
defaultTaskStartToCloseTimout
specified when registering
the workflow type using RegisterWorkflowType. 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.
public StartWorkflowExecutionRequest withTaskStartToCloseTimeout(String taskStartToCloseTimeout)
defaultTaskStartToCloseTimout
specified when registering
the workflow type using RegisterWorkflowType. 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
taskStartToCloseTimeout
- Specifies the maximum duration of decision tasks for this workflow
execution. This parameter overrides the
defaultTaskStartToCloseTimout
specified when registering
the workflow type using RegisterWorkflowType. 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.
public String getChildPolicy()
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
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 setChildPolicy(String childPolicy)
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
childPolicy
- If set, specifies the policy to use for the child workflow executions
of this workflow execution if it is terminated, by calling the
TerminateWorkflowExecution action explicitly or due to an
expired timeout. This policy overrides the default child policy
specified when registering the workflow type using
RegisterWorkflowType. 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 StartWorkflowExecutionRequest withChildPolicy(String childPolicy)
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
childPolicy
- If set, specifies the policy to use for the child workflow executions
of this workflow execution if it is terminated, by calling the
TerminateWorkflowExecution action explicitly or due to an
expired timeout. This policy overrides the default child policy
specified when registering the workflow type using
RegisterWorkflowType. 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 setChildPolicy(ChildPolicy childPolicy)
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
childPolicy
- If set, specifies the policy to use for the child workflow executions
of this workflow execution if it is terminated, by calling the
TerminateWorkflowExecution action explicitly or due to an
expired timeout. This policy overrides the default child policy
specified when registering the workflow type using
RegisterWorkflowType. 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 StartWorkflowExecutionRequest withChildPolicy(ChildPolicy childPolicy)
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
childPolicy
- If set, specifies the policy to use for the child workflow executions
of this workflow execution if it is terminated, by calling the
TerminateWorkflowExecution action explicitly or due to an
expired timeout. This policy overrides the default child policy
specified when registering the workflow type using
RegisterWorkflowType. 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 toString()
toString
in class Object
Object.toString()
Copyright © 2014. All rights reserved.