@Generated(value="software.amazon.awssdk:codegen") public final class WorkflowTypeConfiguration extends Object implements StructuredPojo, ToCopyableBuilder<WorkflowTypeConfiguration.Builder,WorkflowTypeConfiguration>
The configuration settings of a workflow type.
Modifier and Type | Class and Description |
---|---|
static interface |
WorkflowTypeConfiguration.Builder |
Modifier and Type | Method and Description |
---|---|
static WorkflowTypeConfiguration.Builder |
builder() |
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.
|
String |
defaultChildPolicyAsString()
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 |
defaultExecutionStartToCloseTimeout()
The default maximum duration, specified when registering the workflow type, for executions of this workflow type.
|
String |
defaultLambdaRole()
The default IAM role attached to this workflow type.
|
TaskList |
defaultTaskList()
The default task list, specified when registering the workflow type, for decisions tasks scheduled for workflow
executions of this type.
|
String |
defaultTaskPriority()
The default task priority, specified when registering the workflow type, for all decision tasks of this workflow
type.
|
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.
|
boolean |
equals(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
static Class<? extends WorkflowTypeConfiguration.Builder> |
serializableBuilderClass() |
WorkflowTypeConfiguration.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
copy
public 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.
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 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.
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 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.
StartChildWorkflowExecution
Decision.public 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.
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 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.
If the service returns an enum value that is not available in the current SDK version,
defaultChildPolicy
will return ChildPolicy.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the
service is available from defaultChildPolicyAsString()
.
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 defaultChildPolicyAsString()
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.
If the service returns an enum value that is not available in the current SDK version,
defaultChildPolicy
will return ChildPolicy.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the
service is available from defaultChildPolicyAsString()
.
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 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 http://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 http ://docs.aws.amazon.com/amazonswf/latest/developerguide/lambda-task.html in the Amazon SWF Developer Guide.
public WorkflowTypeConfiguration.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<WorkflowTypeConfiguration.Builder,WorkflowTypeConfiguration>
public static WorkflowTypeConfiguration.Builder builder()
public static Class<? extends WorkflowTypeConfiguration.Builder> serializableBuilderClass()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.