Class WorkflowTypeConfiguration
- All Implemented Interfaces:
Serializable
,Cloneable
The configuration settings of a workflow type.
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
boolean
Optional. 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.Optional. The default maximum duration, specified when registering the workflow type, for executions of this workflow type.The default IAM role to use when a workflow execution invokes a AWS Lambda function.Optional. The default task list, specified when registering the workflow type, for decisions tasks scheduled for workflow executions of this type.Optional. The default task priority, specified when registering the workflow type, for all decision tasks of this workflow type.Optional. The default maximum duration, specified when registering the workflow type, that a decision task for executions of this workflow type might take before returning completion or failure.int
hashCode()
void
setDefaultChildPolicy
(ChildPolicy defaultChildPolicy) Optional. 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) Optional. 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) Optional. The default maximum duration, specified when registering the workflow type, for executions of this workflow type.void
setDefaultLambdaRole
(String defaultLambdaRole) The default IAM role to use when a workflow execution invokes a AWS Lambda function.void
setDefaultTaskList
(TaskList defaultTaskList) Optional. The default task list, specified when registering the workflow type, for decisions tasks scheduled for workflow executions of this type.void
setDefaultTaskPriority
(String defaultTaskPriority) Optional. The default task priority, specified when registering the workflow type, for all decision tasks of this workflow type.void
setDefaultTaskStartToCloseTimeout
(String defaultTaskStartToCloseTimeout) Optional. The default maximum duration, specified when registering the workflow type, that a decision task for executions of this workflow type might take before returning completion or failure.toString()
Returns a string representation of this object; useful for testing and debugging.withDefaultChildPolicy
(ChildPolicy defaultChildPolicy) Optional. 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.withDefaultChildPolicy
(String defaultChildPolicy) Optional. 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.withDefaultExecutionStartToCloseTimeout
(String defaultExecutionStartToCloseTimeout) Optional. The default maximum duration, specified when registering the workflow type, for executions of this workflow type.withDefaultLambdaRole
(String defaultLambdaRole) The default IAM role to use when a workflow execution invokes a AWS Lambda function.withDefaultTaskList
(TaskList defaultTaskList) Optional. The default task list, specified when registering the workflow type, for decisions tasks scheduled for workflow executions of this type.withDefaultTaskPriority
(String defaultTaskPriority) Optional. The default task priority, specified when registering the workflow type, for all decision tasks of this workflow type.withDefaultTaskStartToCloseTimeout
(String defaultTaskStartToCloseTimeout) Optional. The default maximum duration, specified when registering the workflow type, that a decision task for executions of this workflow type might take before returning completion or failure.
-
Constructor Details
-
WorkflowTypeConfiguration
public WorkflowTypeConfiguration()
-
-
Method Details
-
setDefaultTaskStartToCloseTimeout
Optional. The default maximum duration, specified when registering the workflow type, that a decision task for executions of this workflow type might take before returning completion or failure. If the task does not close in the specified time then the task is automatically timed out and rescheduled. If the decider eventually reports a completion or failure, it is ignored. 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.
- Parameters:
defaultTaskStartToCloseTimeout
- Optional. The default maximum duration, specified when registering the workflow type, that a decision task for executions of this workflow type might take before returning completion or failure. If the task does not close in the specified time then the task is automatically timed out and rescheduled. If the decider eventually reports a completion or failure, it is ignored. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or theStartChildWorkflowExecution
decision.
-
getDefaultTaskStartToCloseTimeout
Optional. The default maximum duration, specified when registering the workflow type, that a decision task for executions of this workflow type might take before returning completion or failure. If the task does not close in the specified time then the task is automatically timed out and rescheduled. If the decider eventually reports a completion or failure, it is ignored. 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.
- Returns:
- Optional. The default maximum duration, specified when
registering the workflow type, that a decision task for
executions of this workflow type might take before returning
completion or failure. If the task does not close in the
specified time then the task is automatically timed out and
rescheduled. If the decider eventually reports a completion or
failure, it is ignored. This default can be overridden when
starting a workflow execution using the
StartWorkflowExecution action or the
StartChildWorkflowExecution
decision.
-
withDefaultTaskStartToCloseTimeout
public WorkflowTypeConfiguration withDefaultTaskStartToCloseTimeout(String defaultTaskStartToCloseTimeout) Optional. The default maximum duration, specified when registering the workflow type, that a decision task for executions of this workflow type might take before returning completion or failure. If the task does not close in the specified time then the task is automatically timed out and rescheduled. If the decider eventually reports a completion or failure, it is ignored. 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.
- Parameters:
defaultTaskStartToCloseTimeout
- Optional. The default maximum duration, specified when registering the workflow type, that a decision task for executions of this workflow type might take before returning completion or failure. If the task does not close in the specified time then the task is automatically timed out and rescheduled. If the decider eventually reports a completion or failure, it is ignored. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or theStartChildWorkflowExecution
decision.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setDefaultExecutionStartToCloseTimeout
Optional. The default maximum duration, specified when registering the workflow type, for executions of 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.
- Parameters:
defaultExecutionStartToCloseTimeout
- Optional. The default maximum duration, specified when registering the workflow type, for executions of this workflow type. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or theStartChildWorkflowExecution
decision.
-
getDefaultExecutionStartToCloseTimeout
Optional. The default maximum duration, specified when registering the workflow type, for executions of 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.
- Returns:
- Optional. The default maximum duration, specified when
registering the workflow type, for executions of this workflow
type. This default can be overridden when starting a workflow
execution using the StartWorkflowExecution action or the
StartChildWorkflowExecution
decision.
-
withDefaultExecutionStartToCloseTimeout
public WorkflowTypeConfiguration withDefaultExecutionStartToCloseTimeout(String defaultExecutionStartToCloseTimeout) Optional. The default maximum duration, specified when registering the workflow type, for executions of 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.
- Parameters:
defaultExecutionStartToCloseTimeout
- Optional. The default maximum duration, specified when registering the workflow type, for executions of this workflow type. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or theStartChildWorkflowExecution
decision.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setDefaultTaskList
Optional. The default task list, specified when registering the workflow type, for decisions tasks scheduled for workflow executions of this type. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the
StartChildWorkflowExecution
decision.- Parameters:
defaultTaskList
- Optional. The default task list, specified when registering the workflow type, for decisions tasks scheduled for workflow executions of this type. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or theStartChildWorkflowExecution
-
getDefaultTaskList
Optional. The default task list, specified when registering the workflow type, for decisions tasks scheduled for workflow executions of this type. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the
StartChildWorkflowExecution
decision.- Returns:
- Optional. The default task list, specified when registering
the workflow type, for decisions tasks scheduled for workflow
executions of this type. This default can be overridden when
starting a workflow execution using the
StartWorkflowExecution action or the
StartChildWorkflowExecution
-
withDefaultTaskList
Optional. The default task list, specified when registering the workflow type, for decisions tasks scheduled for workflow executions of this type. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the
StartChildWorkflowExecution
decision.- Parameters:
defaultTaskList
- Optional. The default task list, specified when registering the workflow type, for decisions tasks scheduled for workflow executions of this type. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or theStartChildWorkflowExecution
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setDefaultTaskPriority
Optional. The default task priority, specified when registering the workflow type, for all decision tasks of this workflow type. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the
StartChildWorkflowExecution
decision.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:
defaultTaskPriority
- Optional. The default task priority, specified when registering the workflow type, for all decision tasks of this workflow type. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or theStartChildWorkflowExecution
decision.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
-
getDefaultTaskPriority
Optional. The default task priority, specified when registering the workflow type, for all decision tasks of this workflow type. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the
StartChildWorkflowExecution
decision.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:
- Optional. The default task priority, specified when
registering the workflow type, for all decision tasks of this
workflow type. This default can be overridden when starting a
workflow execution using the StartWorkflowExecution action
or the
StartChildWorkflowExecution
decision.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
-
withDefaultTaskPriority
Optional. The default task priority, specified when registering the workflow type, for all decision tasks of this workflow type. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the
StartChildWorkflowExecution
decision.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:
defaultTaskPriority
- Optional. The default task priority, specified when registering the workflow type, for all decision tasks of this workflow type. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or theStartChildWorkflowExecution
decision.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:
- Returns a reference to this object so that method calls can be chained together.
-
setDefaultChildPolicy
Optional. 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:
- 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.
- Parameters:
defaultChildPolicy
- Optional. 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 theStartChildWorkflowExecution
decision.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.
- See Also:
-
getDefaultChildPolicy
Optional. 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:
- 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.
- Returns:
- Optional. 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:
- 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.
- See Also:
-
withDefaultChildPolicy
Optional. 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:
- 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.
- Parameters:
defaultChildPolicy
- Optional. 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 theStartChildWorkflowExecution
decision.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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
setDefaultChildPolicy
Optional. 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:
- 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.
- Parameters:
defaultChildPolicy
- Optional. 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 theStartChildWorkflowExecution
decision.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.
- See Also:
-
withDefaultChildPolicy
Optional. 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:
- 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.
- Parameters:
defaultChildPolicy
- Optional. 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 theStartChildWorkflowExecution
decision.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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
setDefaultLambdaRole
The default IAM role to use when a workflow execution invokes a AWS Lambda function.
- Parameters:
defaultLambdaRole
- The default IAM role to use when a workflow execution invokes a AWS Lambda function.
-
getDefaultLambdaRole
The default IAM role to use when a workflow execution invokes a AWS Lambda function.
- Returns:
- The default IAM role to use when a workflow execution invokes a AWS Lambda function.
-
withDefaultLambdaRole
The default IAM role to use when a workflow execution invokes a AWS Lambda function.
- Parameters:
defaultLambdaRole
- The default IAM role to use when a workflow execution invokes a AWS Lambda function.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
toString
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
clone
-