Package io.temporal.workflow

Enum HandlerUnfinishedPolicy

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<HandlerUnfinishedPolicy>
    public enum HandlerUnfinishedPolicy
extends java.lang.Enum<HandlerUnfinishedPolicy>
    Actions taken if a workflow terminates with running handlers.

    Policy defining actions taken when a workflow exits while update or signal handlers are running. The workflow exit may be due to successful return, failure, cancellation, or continue-as-new.

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      ABANDON
      Abandon the handler.
      WARN_AND_ABANDON
      Issue a warning in addition to abandon.

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static HandlerUnfinishedPolicy valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static HandlerUnfinishedPolicy[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.

      • Methods inherited from class java.lang.Enum

        clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Enum Constant Detail

      • WARN_AND_ABANDON

        public static final HandlerUnfinishedPolicy WARN_AND_ABANDON
        Issue a warning in addition to abandon.

      • ABANDON

        public static final HandlerUnfinishedPolicy ABANDON
        Abandon the handler.

        In the case of an update handler this means that the client will receive an error rather than the update result.

    • Method Detail

      • values

        public static HandlerUnfinishedPolicy[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (HandlerUnfinishedPolicy c : HandlerUnfinishedPolicy.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static HandlerUnfinishedPolicy valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null