Class StartWorkflowExecutionRequest
- java.lang.Object
-
- com.amazonaws.AmazonWebServiceRequest
-
- com.amazonaws.services.simpleworkflow.model.StartWorkflowExecutionRequest
-
- All Implemented Interfaces:
ReadLimitInfo
,Serializable
,Cloneable
public class StartWorkflowExecutionRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
- See Also:
- Serialized Form
-
-
Field Summary
-
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
-
Constructor Summary
Constructors Constructor Description StartWorkflowExecutionRequest()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description StartWorkflowExecutionRequest
clone()
Creates a shallow clone of this request.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.String
getLambdaRole()
The ARN of an IAM role that authorizes Amazon SWF to invoke AWS Lambda functions.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
getTaskPriority()
The task priority to use 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
setLambdaRole(String lambdaRole)
The ARN of an IAM role that authorizes Amazon SWF to invoke AWS Lambda functions.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
setTaskPriority(String taskPriority)
The task priority to use 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
withLambdaRole(String lambdaRole)
The ARN of an IAM role that authorizes Amazon SWF to invoke AWS Lambda functions.StartWorkflowExecutionRequest
withTagList(String... tagList)
The list of tags to associate with the workflow execution.StartWorkflowExecutionRequest
withTagList(Collection<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
withTaskPriority(String taskPriority)
The task priority to use 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.-
Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
-
-
-
-
Method Detail
-
setDomain
public void setDomain(String domain)
The name of the domain in which the workflow execution is created.
- Parameters:
domain
- The name of the domain in which the workflow execution is created.
-
getDomain
public String getDomain()
The name of the domain in which the workflow execution is created.
- Returns:
- The name of the domain in which the workflow execution is created.
-
withDomain
public StartWorkflowExecutionRequest withDomain(String domain)
The name of the domain in which the workflow execution is created.
- Parameters:
domain
- The name of the domain in which the workflow execution is created.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setWorkflowId
public void setWorkflowId(String 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 quotarnquot.- Parameters:
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 sameworkflowId
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 quotarnquot.
-
getWorkflowId
public String getWorkflowId()
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 quotarnquot.- Returns:
- 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 quotarnquot.
-
withWorkflowId
public StartWorkflowExecutionRequest withWorkflowId(String 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 quotarnquot.- Parameters:
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 sameworkflowId
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 quotarnquot.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setWorkflowType
public void setWorkflowType(WorkflowType workflowType)
The type of the workflow to start.
- Parameters:
workflowType
- The type of the workflow to start.
-
getWorkflowType
public WorkflowType getWorkflowType()
The type of the workflow to start.
- Returns:
- The type of the workflow to start.
-
withWorkflowType
public StartWorkflowExecutionRequest withWorkflowType(WorkflowType workflowType)
The type of the workflow to start.
- Parameters:
workflowType
- The type of the workflow to start.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setTaskList
public void setTaskList(TaskList 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.A task list for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default task list was specified at registration time then a fault will be returned. 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 quotarnquot.- Parameters:
taskList
- The task list to use for the decision tasks generated for this workflow execution. This overrides thedefaultTaskList
specified when registering the workflow type.A task list for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default task list was specified at registration time then a fault will be returned. 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 quotarnquot.
-
getTaskList
public TaskList getTaskList()
The task list to use for the decision tasks generated for this workflow execution. This overrides the
defaultTaskList
specified when registering the workflow type.A task list for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default task list was specified at registration time then a fault will be returned. 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 quotarnquot.- Returns:
- The task list to use for the decision tasks generated for this
workflow execution. This overrides the
defaultTaskList
specified when registering the workflow type.A task list for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default task list was specified at registration time then a fault will be returned. 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 quotarnquot.
-
withTaskList
public StartWorkflowExecutionRequest withTaskList(TaskList 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.A task list for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default task list was specified at registration time then a fault will be returned. 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 quotarnquot.- Parameters:
taskList
- The task list to use for the decision tasks generated for this workflow execution. This overrides thedefaultTaskList
specified when registering the workflow type.A task list for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default task list was specified at registration time then a fault will be returned. 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 quotarnquot.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setTaskPriority
public void setTaskPriority(String taskPriority)
The task priority to use for this workflow execution. This will override any default priority that was assigned when the workflow type was registered. If not set, then the default task priority for the workflow type will be used. Valid values are integers that range from Java's
Integer.MIN_VALUE
(-2147483648) toInteger.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.
- Parameters:
taskPriority
- The task priority to use for this workflow execution. This will override any default priority that was assigned when the workflow type was registered. If not set, then the default task priority for the workflow type will be used. Valid values are integers that range from Java'sInteger.MIN_VALUE
(-2147483648) toInteger.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.
-
getTaskPriority
public String getTaskPriority()
The task priority to use for this workflow execution. This will override any default priority that was assigned when the workflow type was registered. If not set, then the default task priority for the workflow type will be used. Valid values are integers that range from Java's
Integer.MIN_VALUE
(-2147483648) toInteger.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:
- The task priority to use for this workflow execution. This will
override any default priority that was assigned when the workflow
type was registered. If not set, then the default task priority
for the workflow type will be used. Valid values are integers
that range from Java's
Integer.MIN_VALUE
(-2147483648) toInteger.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.
-
withTaskPriority
public StartWorkflowExecutionRequest withTaskPriority(String taskPriority)
The task priority to use for this workflow execution. This will override any default priority that was assigned when the workflow type was registered. If not set, then the default task priority for the workflow type will be used. Valid values are integers that range from Java's
Integer.MIN_VALUE
(-2147483648) toInteger.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.
- Parameters:
taskPriority
- The task priority to use for this workflow execution. This will override any default priority that was assigned when the workflow type was registered. If not set, then the default task priority for the workflow type will be used. Valid values are integers that range from Java'sInteger.MIN_VALUE
(-2147483648) toInteger.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:
- Returns a reference to this object so that method calls can be chained together.
-
setInput
public void setInput(String 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 theWorkflowExecutionStarted
history event.- Parameters:
input
- The input for the workflow execution. This is a free form string which should be meaningful to the workflow you are starting. Thisinput
is made available to the new workflow execution in theWorkflowExecutionStarted
history event.
-
getInput
public String getInput()
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 theWorkflowExecutionStarted
history event.- Returns:
- 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 theWorkflowExecutionStarted
history event.
-
withInput
public StartWorkflowExecutionRequest withInput(String 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 theWorkflowExecutionStarted
history event.- Parameters:
input
- The input for the workflow execution. This is a free form string which should be meaningful to the workflow you are starting. Thisinput
is made available to the new workflow execution in theWorkflowExecutionStarted
history event.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setExecutionStartToCloseTimeout
public void setExecutionStartToCloseTimeout(String executionStartToCloseTimeout)
The total duration for this workflow execution. This overrides the defaultExecutionStartToCloseTimeout specified when registering the workflow type.
The duration is specified in seconds; an integer 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.
An execution start-to-close timeout must be specified either through this parameter or as a default when the workflow type is registered. If neither this parameter nor a default execution start-to-close timeout is specified, a fault is returned. - Parameters:
executionStartToCloseTimeout
- The total duration for this workflow execution. This overrides the defaultExecutionStartToCloseTimeout specified when registering the workflow type.The duration is specified in seconds; an integer 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.
An execution start-to-close timeout must be specified either through this parameter or as a default when the workflow type is registered. If neither this parameter nor a default execution start-to-close timeout is specified, a fault is returned.
-
getExecutionStartToCloseTimeout
public String getExecutionStartToCloseTimeout()
The total duration for this workflow execution. This overrides the defaultExecutionStartToCloseTimeout specified when registering the workflow type.
The duration is specified in seconds; an integer 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.
An execution start-to-close timeout must be specified either through this parameter or as a default when the workflow type is registered. If neither this parameter nor a default execution start-to-close timeout is specified, a fault is returned. - Returns:
- The total duration for this workflow execution. This overrides
the defaultExecutionStartToCloseTimeout specified when
registering the workflow type.
The duration is specified in seconds; an integer 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.
An execution start-to-close timeout must be specified either through this parameter or as a default when the workflow type is registered. If neither this parameter nor a default execution start-to-close timeout is specified, a fault is returned.
-
withExecutionStartToCloseTimeout
public StartWorkflowExecutionRequest withExecutionStartToCloseTimeout(String executionStartToCloseTimeout)
The total duration for this workflow execution. This overrides the defaultExecutionStartToCloseTimeout specified when registering the workflow type.
The duration is specified in seconds; an integer 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.
An execution start-to-close timeout must be specified either through this parameter or as a default when the workflow type is registered. If neither this parameter nor a default execution start-to-close timeout is specified, a fault is returned. - Parameters:
executionStartToCloseTimeout
- The total duration for this workflow execution. This overrides the defaultExecutionStartToCloseTimeout specified when registering the workflow type.The duration is specified in seconds; an integer 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.
An execution start-to-close timeout must be specified either through this parameter or as a default when the workflow type is registered. If neither this parameter nor a default execution start-to-close timeout is specified, a fault is returned. - Returns:
- Returns a reference to this object so that method calls can be chained together.
-
getTagList
public List<String> getTagList()
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.
- Returns:
- 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.
-
setTagList
public void setTagList(Collection<String> 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.
- Parameters:
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.
-
withTagList
public StartWorkflowExecutionRequest withTagList(String... 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.
NOTE: This method appends the values to the existing list (if any). Use
setTagList(java.util.Collection)
orwithTagList(java.util.Collection)
if you want to override the existing values.- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withTagList
public StartWorkflowExecutionRequest withTagList(Collection<String> 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.
- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setTaskStartToCloseTimeout
public void setTaskStartToCloseTimeout(String 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 duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.
A task start-to-close timeout for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default task start-to-close timeout was specified at registration time then a fault will be returned. - Parameters:
taskStartToCloseTimeout
- Specifies the maximum duration of decision tasks for this workflow execution. This parameter overrides thedefaultTaskStartToCloseTimout
specified when registering the workflow type using RegisterWorkflowType.The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.
A task start-to-close timeout for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default task start-to-close timeout was specified at registration time then a fault will be returned.
-
getTaskStartToCloseTimeout
public String getTaskStartToCloseTimeout()
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 duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.
A task start-to-close timeout for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default task start-to-close timeout was specified at registration time then a fault will be returned. - Returns:
- 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 duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.
A task start-to-close timeout for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default task start-to-close timeout was specified at registration time then a fault will be returned.
-
withTaskStartToCloseTimeout
public StartWorkflowExecutionRequest withTaskStartToCloseTimeout(String 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 duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.
A task start-to-close timeout for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default task start-to-close timeout was specified at registration time then a fault will be returned. - Parameters:
taskStartToCloseTimeout
- Specifies the maximum duration of decision tasks for this workflow execution. This parameter overrides thedefaultTaskStartToCloseTimout
specified when registering the workflow type using RegisterWorkflowType.The duration is specified in seconds; an integer greater than or equal to 0. The value "NONE" can be used to specify unlimited duration.
A task start-to-close timeout for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default task start-to-close timeout was specified at registration time then a fault will be returned. - Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setChildPolicy
public 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. This policy overrides the default child policy specified when registering the workflow type using RegisterWorkflowType.
The supported child policies are:
- TERMINATE: the child executions will be terminated.
- REQUEST_CANCEL: a request to cancel will be attempted for each
child execution by recording a
WorkflowExecutionCancelRequested
event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event. - ABANDON: no action will be taken. The child executions will continue to run.
A child policy for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default child policy was specified at registration time then a fault will be returned. - Parameters:
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:
- TERMINATE: the child executions will be terminated.
- REQUEST_CANCEL: a request to cancel will be attempted
for each child execution by recording a
WorkflowExecutionCancelRequested
event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event. - ABANDON: no action will be taken. The child executions will continue to run.
A child policy for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default child policy was specified at registration time then a fault will be returned. - See Also:
ChildPolicy
-
getChildPolicy
public 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. This policy overrides the default child policy specified when registering the workflow type using RegisterWorkflowType.
The supported child policies are:
- TERMINATE: the child executions will be terminated.
- REQUEST_CANCEL: a request to cancel will be attempted for each
child execution by recording a
WorkflowExecutionCancelRequested
event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event. - ABANDON: no action will be taken. The child executions will continue to run.
A child policy for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default child policy was specified at registration time then a fault will be returned. - Returns:
- 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:
- TERMINATE: the child executions will be terminated.
- REQUEST_CANCEL: a request to cancel will be attempted
for each child execution by recording a
WorkflowExecutionCancelRequested
event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event. - ABANDON: no action will be taken. The child executions will continue to run.
A child policy for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default child policy was specified at registration time then a fault will be returned. - See Also:
ChildPolicy
-
withChildPolicy
public 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. This policy overrides the default child policy specified when registering the workflow type using RegisterWorkflowType.
The supported child policies are:
- TERMINATE: the child executions will be terminated.
- REQUEST_CANCEL: a request to cancel will be attempted for each
child execution by recording a
WorkflowExecutionCancelRequested
event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event. - ABANDON: no action will be taken. The child executions will continue to run.
A child policy for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default child policy was specified at registration time then a fault will be returned. - Parameters:
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:
- TERMINATE: the child executions will be terminated.
- REQUEST_CANCEL: a request to cancel will be attempted
for each child execution by recording a
WorkflowExecutionCancelRequested
event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event. - ABANDON: no action will be taken. The child executions will continue to run.
A child policy for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default child policy was specified at registration time then a fault will be returned. - Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
ChildPolicy
-
setChildPolicy
public 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. This policy overrides the default child policy specified when registering the workflow type using RegisterWorkflowType.
The supported child policies are:
- TERMINATE: the child executions will be terminated.
- REQUEST_CANCEL: a request to cancel will be attempted for each
child execution by recording a
WorkflowExecutionCancelRequested
event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event. - ABANDON: no action will be taken. The child executions will continue to run.
A child policy for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default child policy was specified at registration time then a fault will be returned. - Parameters:
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:
- TERMINATE: the child executions will be terminated.
- REQUEST_CANCEL: a request to cancel will be attempted
for each child execution by recording a
WorkflowExecutionCancelRequested
event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event. - ABANDON: no action will be taken. The child executions will continue to run.
A child policy for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default child policy was specified at registration time then a fault will be returned. - See Also:
ChildPolicy
-
withChildPolicy
public 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. This policy overrides the default child policy specified when registering the workflow type using RegisterWorkflowType.
The supported child policies are:
- TERMINATE: the child executions will be terminated.
- REQUEST_CANCEL: a request to cancel will be attempted for each
child execution by recording a
WorkflowExecutionCancelRequested
event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event. - ABANDON: no action will be taken. The child executions will continue to run.
A child policy for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default child policy was specified at registration time then a fault will be returned. - Parameters:
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:
- TERMINATE: the child executions will be terminated.
- REQUEST_CANCEL: a request to cancel will be attempted
for each child execution by recording a
WorkflowExecutionCancelRequested
event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event. - ABANDON: no action will be taken. The child executions will continue to run.
A child policy for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default child policy was specified at registration time then a fault will be returned. - Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
ChildPolicy
-
setLambdaRole
public void setLambdaRole(String lambdaRole)
The ARN of an IAM role that authorizes Amazon SWF to invoke AWS Lambda functions.
In order for this workflow execution to invoke AWS Lambda functions, an appropriate IAM role must be specified either as a default for the workflow type or through this field. - Parameters:
lambdaRole
- The ARN of an IAM role that authorizes Amazon SWF to invoke AWS Lambda functions.In order for this workflow execution to invoke AWS Lambda functions, an appropriate IAM role must be specified either as a default for the workflow type or through this field.
-
getLambdaRole
public String getLambdaRole()
The ARN of an IAM role that authorizes Amazon SWF to invoke AWS Lambda functions.
In order for this workflow execution to invoke AWS Lambda functions, an appropriate IAM role must be specified either as a default for the workflow type or through this field. - Returns:
- The ARN of an IAM role that authorizes Amazon SWF to invoke AWS
Lambda functions.
In order for this workflow execution to invoke AWS Lambda functions, an appropriate IAM role must be specified either as a default for the workflow type or through this field.
-
withLambdaRole
public StartWorkflowExecutionRequest withLambdaRole(String lambdaRole)
The ARN of an IAM role that authorizes Amazon SWF to invoke AWS Lambda functions.
In order for this workflow execution to invoke AWS Lambda functions, an appropriate IAM role must be specified either as a default for the workflow type or through this field. - Parameters:
lambdaRole
- The ARN of an IAM role that authorizes Amazon SWF to invoke AWS Lambda functions.In order for this workflow execution to invoke AWS Lambda functions, an appropriate IAM role must be specified either as a default for the workflow type or through this field. - 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; useful for testing and debugging.- Overrides:
toString
in classObject
- Returns:
- A string representation of this object.
- See Also:
Object.toString()
-
clone
public StartWorkflowExecutionRequest clone()
Description copied from class:AmazonWebServiceRequest
Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.- Overrides:
clone
in classAmazonWebServiceRequest
- See Also:
Object.clone()
-
-