Package software.amazon.lambda.durable.config

Record Class CompletionConfig

java.lang.Object
java.lang.Record
software.amazon.lambda.durable.config.CompletionConfig
public record CompletionConfig(Integer minSuccessful, Integer toleratedFailureCount, Double toleratedFailurePercentage, Function<CompletionConfig.CompletionStatus,CompletionConfig.CompletionDecision> shouldComplete) extends Record
Controls when a concurrent operation (map or parallel) completes.

Provides factory methods for common completion strategies and fine-grained control via minSuccessful, toleratedFailureCount, toleratedFailurePercentage, and shouldComplete.

  • Constructor Details

    • CompletionConfig

      public CompletionConfig(Integer minSuccessful, Integer toleratedFailureCount, Double toleratedFailurePercentage)

    • CompletionConfig

      public CompletionConfig(Integer minSuccessful, Integer toleratedFailureCount, Double toleratedFailurePercentage, Function<CompletionConfig.CompletionStatus,CompletionConfig.CompletionDecision> shouldComplete)
      Creates an instance of a CompletionConfig record class.
      Parameters:
      minSuccessful - the value for the minSuccessful record component
      toleratedFailureCount - the value for the toleratedFailureCount record component
      toleratedFailurePercentage - the value for the toleratedFailurePercentage record component
      shouldComplete - the value for the shouldComplete record component

  • Method Details

    • allSuccessful

      public static CompletionConfig allSuccessful()
      All items must succeed. Zero failures tolerated.

    • allCompleted

      public static CompletionConfig allCompleted()
      All items run regardless of failures. Failures captured per-item.

    • firstSuccessful

      public static CompletionConfig firstSuccessful()
      Complete as soon as the first item succeeds.

    • minSuccessful

      public static CompletionConfig minSuccessful(int count)
      Complete when the specified number of items have succeeded.

    • toleratedFailureCount

      public static CompletionConfig toleratedFailureCount(int count)
      Complete when more than the specified number of failures have occurred.

    • toleratedFailurePercentage

      public static CompletionConfig toleratedFailurePercentage(double percentage)
      Complete when the failure percentage exceeds the specified threshold (0.0 to 1.0).

    • shouldComplete

      public static CompletionConfig shouldComplete(Function<CompletionConfig.CompletionStatus,CompletionConfig.CompletionDecision> shouldComplete)
      Complete when the function returns a completing decision.

      The decision controls whether the operation completes, the reported completion status, and whether that status represents success.

    • completionDecisionFunction

      public Function<CompletionConfig.CompletionStatus,CompletionConfig.CompletionDecision> completionDecisionFunction()
      Returns the completion decision function. Legacy threshold fields are converted into this function so concurrent operations only need one completion mechanism.

    • hasCustomShouldComplete

      public boolean hasCustomShouldComplete()
      Returns:
      true when a custom completion function is configured.

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • minSuccessful

      public Integer minSuccessful()
      Returns the value of the minSuccessful record component.
      Returns:
      the value of the minSuccessful record component

    • toleratedFailureCount

      public Integer toleratedFailureCount()
      Returns the value of the toleratedFailureCount record component.
      Returns:
      the value of the toleratedFailureCount record component

    • toleratedFailurePercentage

      public Double toleratedFailurePercentage()
      Returns the value of the toleratedFailurePercentage record component.
      Returns:
      the value of the toleratedFailurePercentage record component

    • shouldComplete

      public Function<CompletionConfig.CompletionStatus,CompletionConfig.CompletionDecision> shouldComplete()
      Returns the value of the shouldComplete record component.
      Returns:
      the value of the shouldComplete record component