@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class WorkflowTypeConfiguration extends Object implements Serializable, Cloneable, StructuredPojo
The configuration settings of a workflow type.
Constructor and Description |
---|
WorkflowTypeConfiguration() |
Modifier and Type | Method and Description |
---|---|
WorkflowTypeConfiguration |
clone() |
boolean |
equals(Object obj) |
String |
getDefaultChildPolicy()
The default policy to use for the child workflow executions when a workflow execution of this type is terminated,
by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout.
|
String |
getDefaultExecutionStartToCloseTimeout()
The default maximum duration, specified when registering the workflow type, for executions of this workflow type.
|
String |
getDefaultLambdaRole()
The default IAM role attached to this workflow type.
|
TaskList |
getDefaultTaskList()
The default task list, specified when registering the workflow type, for decisions tasks scheduled for workflow
executions of this type.
|
String |
getDefaultTaskPriority()
The default task priority, specified when registering the workflow type, for all decision tasks of this workflow
type.
|
String |
getDefaultTaskStartToCloseTimeout()
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 |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setDefaultChildPolicy(ChildPolicy defaultChildPolicy)
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)
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)
The default maximum duration, specified when registering the workflow type, for executions of this workflow type.
|
void |
setDefaultLambdaRole(String defaultLambdaRole)
The default IAM role attached to this workflow type.
|
void |
setDefaultTaskList(TaskList defaultTaskList)
The default task list, specified when registering the workflow type, for decisions tasks scheduled for workflow
executions of this type.
|
void |
setDefaultTaskPriority(String defaultTaskPriority)
The default task priority, specified when registering the workflow type, for all decision tasks of this workflow
type.
|
void |
setDefaultTaskStartToCloseTimeout(String defaultTaskStartToCloseTimeout)
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.
|
String |
toString()
Returns a string representation of this object.
|
WorkflowTypeConfiguration |
withDefaultChildPolicy(ChildPolicy defaultChildPolicy)
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.
|
WorkflowTypeConfiguration |
withDefaultChildPolicy(String defaultChildPolicy)
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.
|
WorkflowTypeConfiguration |
withDefaultExecutionStartToCloseTimeout(String defaultExecutionStartToCloseTimeout)
The default maximum duration, specified when registering the workflow type, for executions of this workflow type.
|
WorkflowTypeConfiguration |
withDefaultLambdaRole(String defaultLambdaRole)
The default IAM role attached to this workflow type.
|
WorkflowTypeConfiguration |
withDefaultTaskList(TaskList defaultTaskList)
The default task list, specified when registering the workflow type, for decisions tasks scheduled for workflow
executions of this type.
|
WorkflowTypeConfiguration |
withDefaultTaskPriority(String defaultTaskPriority)
The default task priority, specified when registering the workflow type, for all decision tasks of this workflow
type.
|
WorkflowTypeConfiguration |
withDefaultTaskStartToCloseTimeout(String defaultTaskStartToCloseTimeout)
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.
|
public void setDefaultTaskStartToCloseTimeout(String defaultTaskStartToCloseTimeout)
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 doesn'tdo 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
. You can use
NONE
to specify unlimited duration.
defaultTaskStartToCloseTimeout
- 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 doesn'tdo
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
. You can use
NONE
to specify unlimited duration.
public String getDefaultTaskStartToCloseTimeout()
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 doesn'tdo 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
. You can use
NONE
to specify unlimited duration.
StartChildWorkflowExecution
Decision.
The duration is specified in seconds, an integer greater than or equal to 0
. You can use
NONE
to specify unlimited duration.
public WorkflowTypeConfiguration withDefaultTaskStartToCloseTimeout(String defaultTaskStartToCloseTimeout)
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 doesn'tdo 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
. You can use
NONE
to specify unlimited duration.
defaultTaskStartToCloseTimeout
- 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 doesn'tdo
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
. You can use
NONE
to specify unlimited duration.
public void setDefaultExecutionStartToCloseTimeout(String defaultExecutionStartToCloseTimeout)
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
. You can use
NONE
to specify unlimited duration.
defaultExecutionStartToCloseTimeout
- 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
. You can use
NONE
to specify unlimited duration.
public String getDefaultExecutionStartToCloseTimeout()
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
. You can use
NONE
to specify unlimited duration.
StartChildWorkflowExecution
Decision.
The duration is specified in seconds, an integer greater than or equal to 0
. You can use
NONE
to specify unlimited duration.
public WorkflowTypeConfiguration withDefaultExecutionStartToCloseTimeout(String defaultExecutionStartToCloseTimeout)
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
. You can use
NONE
to specify unlimited duration.
defaultExecutionStartToCloseTimeout
- 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
. You can use
NONE
to specify unlimited duration.
public void setDefaultTaskList(TaskList defaultTaskList)
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.
defaultTaskList
- 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.public TaskList getDefaultTaskList()
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.
StartChildWorkflowExecution
Decision.public WorkflowTypeConfiguration withDefaultTaskList(TaskList defaultTaskList)
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.
defaultTaskList
- 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.public void setDefaultTaskPriority(String defaultTaskPriority)
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) to
Integer.MAX_VALUE
(2147483647). Higher numbers indicate higher priority.
For more information about setting task priority, see Setting Task Priority in the Amazon SWF Developer Guide.
defaultTaskPriority
- 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) to
Integer.MAX_VALUE
(2147483647). Higher numbers indicate higher priority.
For more information about setting task priority, see Setting Task Priority in the Amazon SWF Developer Guide.
public String getDefaultTaskPriority()
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) to
Integer.MAX_VALUE
(2147483647). Higher numbers indicate higher priority.
For more information about setting task priority, see Setting Task Priority in the Amazon SWF Developer Guide.
StartChildWorkflowExecution
decision.
Valid values are integers that range from Java's Integer.MIN_VALUE
(-2147483648) to
Integer.MAX_VALUE
(2147483647). Higher numbers indicate higher priority.
For more information about setting task priority, see Setting Task Priority in the Amazon SWF Developer Guide.
public WorkflowTypeConfiguration withDefaultTaskPriority(String defaultTaskPriority)
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) to
Integer.MAX_VALUE
(2147483647). Higher numbers indicate higher priority.
For more information about setting task priority, see Setting Task Priority in the Amazon SWF Developer Guide.
defaultTaskPriority
- 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) to
Integer.MAX_VALUE
(2147483647). Higher numbers indicate higher priority.
For more information about setting task priority, see Setting Task Priority in the Amazon SWF Developer Guide.
public void setDefaultChildPolicy(String defaultChildPolicy)
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 are terminated.
REQUEST_CANCEL
– A request to cancel is 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 is taken. The child executions continue to run.
defaultChildPolicy
- 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 are terminated.
REQUEST_CANCEL
– A request to cancel is 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 is taken. The child executions continue to run.
ChildPolicy
public String getDefaultChildPolicy()
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 are terminated.
REQUEST_CANCEL
– A request to cancel is 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 is taken. The child executions continue to run.
StartChildWorkflowExecution
Decision.
The supported child policies are:
TERMINATE
– The child executions are terminated.
REQUEST_CANCEL
– A request to cancel is 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 is taken. The child executions continue to run.
ChildPolicy
public WorkflowTypeConfiguration withDefaultChildPolicy(String defaultChildPolicy)
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 are terminated.
REQUEST_CANCEL
– A request to cancel is 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 is taken. The child executions continue to run.
defaultChildPolicy
- 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 are terminated.
REQUEST_CANCEL
– A request to cancel is 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 is taken. The child executions continue to run.
ChildPolicy
public void setDefaultChildPolicy(ChildPolicy defaultChildPolicy)
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 are terminated.
REQUEST_CANCEL
– A request to cancel is 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 is taken. The child executions continue to run.
defaultChildPolicy
- 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 are terminated.
REQUEST_CANCEL
– A request to cancel is 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 is taken. The child executions continue to run.
ChildPolicy
public WorkflowTypeConfiguration withDefaultChildPolicy(ChildPolicy defaultChildPolicy)
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 are terminated.
REQUEST_CANCEL
– A request to cancel is 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 is taken. The child executions continue to run.
defaultChildPolicy
- 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 are terminated.
REQUEST_CANCEL
– A request to cancel is 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 is taken. The child executions continue to run.
ChildPolicy
public void setDefaultLambdaRole(String defaultLambdaRole)
The default IAM role attached to this workflow type.
Executions of this workflow type need IAM roles to invoke Lambda functions. If you don't specify an IAM role when starting this workflow type, the default Lambda role is attached to the execution. For more information, see https://docs.aws.amazon.com/ amazonswf/latest/developerguide/lambda-task.html in the Amazon SWF Developer Guide.
defaultLambdaRole
- The default IAM role attached to this workflow type. Executions of this workflow type need IAM roles to invoke Lambda functions. If you don't specify an IAM role when starting this workflow type, the default Lambda role is attached to the execution. For more information, see https ://docs.aws.amazon.com/amazonswf/latest/developerguide/lambda-task.html in the Amazon SWF Developer Guide.
public String getDefaultLambdaRole()
The default IAM role attached to this workflow type.
Executions of this workflow type need IAM roles to invoke Lambda functions. If you don't specify an IAM role when starting this workflow type, the default Lambda role is attached to the execution. For more information, see https://docs.aws.amazon.com/ amazonswf/latest/developerguide/lambda-task.html in the Amazon SWF Developer Guide.
Executions of this workflow type need IAM roles to invoke Lambda functions. If you don't specify an IAM role when starting this workflow type, the default Lambda role is attached to the execution. For more information, see https ://docs.aws.amazon.com/amazonswf/latest/developerguide/lambda-task.html in the Amazon SWF Developer Guide.
public WorkflowTypeConfiguration withDefaultLambdaRole(String defaultLambdaRole)
The default IAM role attached to this workflow type.
Executions of this workflow type need IAM roles to invoke Lambda functions. If you don't specify an IAM role when starting this workflow type, the default Lambda role is attached to the execution. For more information, see https://docs.aws.amazon.com/ amazonswf/latest/developerguide/lambda-task.html in the Amazon SWF Developer Guide.
defaultLambdaRole
- The default IAM role attached to this workflow type. Executions of this workflow type need IAM roles to invoke Lambda functions. If you don't specify an IAM role when starting this workflow type, the default Lambda role is attached to the execution. For more information, see https ://docs.aws.amazon.com/amazonswf/latest/developerguide/lambda-task.html in the Amazon SWF Developer Guide.
public String toString()
toString
in class Object
Object.toString()
public WorkflowTypeConfiguration clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.