Annotation Interface UpdateMethod

@Retention(RUNTIME) @Target(METHOD) public @interface UpdateMethod
Indicates that the method is an update handler method. An update method gets executed when a workflow receives an update after the validator is called.

This annotation applies only to workflow interface methods.

  • Element Details

    • name

      String name
      Name of the update handler. Default is method name.

      Be careful about names that contain special characters. These names can be used as metric tags. And systems like prometheus ignore metrics which have tags with unsupported characters.

      Name cannot start with __temporal as it is reserved for internal use.

      Default:
      ""

    • description

      String description
      Short description of the update handler. Default is an empty string.
      Default:
      ""

    • unfinishedPolicy

      HandlerUnfinishedPolicy unfinishedPolicy
      Sets the actions taken if a workflow exits with a running instance of this handler.
      Default:
      WARN_AND_ABANDON