Class WorkflowTypeConfiguration
- java.lang.Object
-
- software.amazon.awssdk.services.swf.model.WorkflowTypeConfiguration
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<WorkflowTypeConfiguration.Builder,WorkflowTypeConfiguration>
@Generated("software.amazon.awssdk:codegen") public final class WorkflowTypeConfiguration extends Object implements SdkPojo, Serializable, ToCopyableBuilder<WorkflowTypeConfiguration.Builder,WorkflowTypeConfiguration>
The configuration settings of a workflow type.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceWorkflowTypeConfiguration.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static WorkflowTypeConfiguration.Builderbuilder()ChildPolicydefaultChildPolicy()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.StringdefaultChildPolicyAsString()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.StringdefaultExecutionStartToCloseTimeout()The default maximum duration, specified when registering the workflow type, for executions of this workflow type.StringdefaultLambdaRole()The default IAM role attached to this workflow type.TaskListdefaultTaskList()The default task list, specified when registering the workflow type, for decisions tasks scheduled for workflow executions of this type.StringdefaultTaskPriority()The default task priority, specified when registering the workflow type, for all decision tasks of this workflow type.StringdefaultTaskStartToCloseTimeout()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.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()List<SdkField<?>>sdkFields()static Class<? extends WorkflowTypeConfiguration.Builder>serializableBuilderClass()WorkflowTypeConfiguration.BuildertoBuilder()StringtoString()Returns a string representation of this object.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
defaultTaskStartToCloseTimeout
public final 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
StartChildWorkflowExecutionDecision.The duration is specified in seconds, an integer greater than or equal to
0. You can useNONEto 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
StartChildWorkflowExecutionDecision.The duration is specified in seconds, an integer greater than or equal to
0. You can useNONEto specify unlimited duration.
-
defaultExecutionStartToCloseTimeout
public final 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
StartChildWorkflowExecutionDecision.The duration is specified in seconds, an integer greater than or equal to
0. You can useNONEto 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
StartChildWorkflowExecutionDecision.The duration is specified in seconds, an integer greater than or equal to
0. You can useNONEto specify unlimited duration.
-
defaultTaskList
public final 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
StartChildWorkflowExecutionDecision.- 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
StartChildWorkflowExecutionDecision.
-
defaultTaskPriority
public final 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
StartChildWorkflowExecutiondecision.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
StartChildWorkflowExecutiondecision.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
public final 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
StartChildWorkflowExecutionDecision.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 aWorkflowExecutionCancelRequestedevent 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,
defaultChildPolicywill 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
StartChildWorkflowExecutionDecision.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 aWorkflowExecutionCancelRequestedevent 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:
ChildPolicy
-
-
defaultChildPolicyAsString
public final 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
StartChildWorkflowExecutionDecision.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 aWorkflowExecutionCancelRequestedevent 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,
defaultChildPolicywill 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
StartChildWorkflowExecutionDecision.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 aWorkflowExecutionCancelRequestedevent 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:
ChildPolicy
-
-
defaultLambdaRole
public final 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.
- 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
public WorkflowTypeConfiguration.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<WorkflowTypeConfiguration.Builder,WorkflowTypeConfiguration>
-
builder
public static WorkflowTypeConfiguration.Builder builder()
-
serializableBuilderClass
public static Class<? extends WorkflowTypeConfiguration.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
toString
public final String 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.
-
-