Annotation Interface WorkflowMethod

@Retention(RUNTIME) @Target(METHOD) public @interface WorkflowMethod
Indicates that the method is a workflow method. Workflow method is executed when workflow is started. Workflow completes when workflow method returns. This annotation applies only to workflow interface methods.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String
    name
    Name of the workflow type.

  • Element Details

    • name

      String name
      Name of the workflow type. Default is {short class name}.

      Be careful with names that contain special characters, as these names can be used as metric tags. Systems like Prometheus ignore metrics which have tags with unsupported characters.

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

      Default:
      ""