Class WorkflowTypeConfiguration
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<WorkflowTypeConfiguration.Builder,
WorkflowTypeConfiguration>
The configuration settings of a workflow type.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final ChildPolicy
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.final String
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.final String
The default maximum duration, specified when registering the workflow type, for executions of this workflow type.final String
The default IAM role attached to this workflow type.final TaskList
The default task list, specified when registering the workflow type, for decisions tasks scheduled for workflow executions of this type.final String
The default task priority, specified when registering the workflow type, for all decision tasks of this workflow type.final String
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.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
static Class
<? extends WorkflowTypeConfiguration.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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 useNONE
to specify unlimited duration.- Returns:
- 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 useNONE
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 useNONE
to specify unlimited duration.- Returns:
- 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 useNONE
to specify unlimited duration.
-
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.- Returns:
- 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.
-
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) toInteger.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.
- Returns:
- 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 SWF Developer Guide.
-
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 aWorkflowExecutionCancelRequested
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 returnChildPolicy.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromdefaultChildPolicyAsString()
.- Returns:
- 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 aWorkflowExecutionCancelRequested
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.
-
- See Also:
-
-
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 aWorkflowExecutionCancelRequested
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 returnChildPolicy.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromdefaultChildPolicyAsString()
.- Returns:
- 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 aWorkflowExecutionCancelRequested
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.
-
- See Also:
-
-
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.
- Returns:
- 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.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<WorkflowTypeConfiguration.Builder,
WorkflowTypeConfiguration> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value. -
getValueForField
-
sdkFields
-