Package akka.javasdk.annotations

Annotation Interface TypeName

@Target(TYPE) @Retention(RUNTIME) public @interface TypeName
Annotation to assign a logical type name to events.

The type name is used for several things, such as to identify each event in order to deliver them to the right event consumers. If a logical type name isn't specified, the fully qualified class name is used.

Once an event is persisted, you won't be able to rename your class if no logical type name has been specified, as previously persisted events would have a different identifier.

Therefore, we recommend all event classes use a logical type name.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String
    value
    Logical type name for the annotated type.

  • Element Details

    • value

      String value
      Logical type name for the annotated type. If missing (or defined as Empty String), the fully qualified class name will be used.
      Default:
      ""