Package io.temporal.workflow

Annotation Type 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.

    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      java.lang.String description
      Short description of the update handler.
      java.lang.String name
      Name of the update handler.
      HandlerUnfinishedPolicy unfinishedPolicy
      Sets the actions taken if a workflow exits with a running instance of this handler.

    • Element Detail

      • name

        java.lang.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.

        Default:
        ""

      • description

        java.lang.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:
        io.temporal.workflow.HandlerUnfinishedPolicy.WARN_AND_ABANDON