Class WorkflowExecutionConfiguration

java.lang.Object
software.amazon.awssdk.services.swf.model.WorkflowExecutionConfiguration
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<WorkflowExecutionConfiguration.Builder,WorkflowExecutionConfiguration>
@Generated("software.amazon.awssdk:codegen") public final class WorkflowExecutionConfiguration extends Object implements SdkPojo, Serializable, ToCopyableBuilder<WorkflowExecutionConfiguration.Builder,WorkflowExecutionConfiguration>

The configuration settings for a workflow execution including timeout values, tasklist etc. These configuration settings are determined from the defaults specified when registering the workflow type and those specified when starting the workflow execution.

See Also:

  • Method Details

    • taskStartToCloseTimeout

      public final String taskStartToCloseTimeout()

      The maximum duration allowed for decision tasks for this workflow execution.

      The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

      Returns:
      The maximum duration allowed for decision tasks for this workflow execution.

      The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

    • executionStartToCloseTimeout

      public final String executionStartToCloseTimeout()

      The total duration for this workflow execution.

      The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

      Returns:
      The total duration for this workflow execution.

      The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

    • taskList

      public final TaskList taskList()

      The task list used for the decision tasks generated for this workflow execution.

      Returns:
      The task list used for the decision tasks generated for this workflow execution.

    • taskPriority

      public final String taskPriority()

      The priority assigned to decision tasks for this workflow execution. 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.

      Returns:
      The priority assigned to decision tasks for this workflow execution. 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.

    • childPolicy

      public final ChildPolicy childPolicy()

      The policy to use for the child workflow executions if this workflow execution is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout.

      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, childPolicy will return ChildPolicy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from childPolicyAsString().

      Returns:
      The policy to use for the child workflow executions if this workflow execution is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout.

      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.

      See Also:

    • childPolicyAsString

      public final String childPolicyAsString()

      The policy to use for the child workflow executions if this workflow execution is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout.

      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, childPolicy will return ChildPolicy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from childPolicyAsString().

      Returns:
      The policy to use for the child workflow executions if this workflow execution is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout.

      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.

      See Also:

    • lambdaRole

      public final String lambdaRole()

      The IAM role attached to the child workflow execution.

      Returns:
      The IAM role attached to the child workflow execution.

    • toBuilder

      public WorkflowExecutionConfiguration.Builder 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 interface ToCopyableBuilder<WorkflowExecutionConfiguration.Builder,WorkflowExecutionConfiguration>
      Returns:
      a builder for type T

    • builder

      public static WorkflowExecutionConfiguration.Builder builder()

    • serializableBuilderClass

      public static Class<? extends WorkflowExecutionConfiguration.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.