Package akka.javasdk.annotations

Annotation Interface Component

@Target(TYPE) @Retention(RUNTIME) @Documented public @interface Component
Assign metadata to a component (required for all component types aside from Endpoints).

The id should be unique among the different components.

In the case of Entities, Workflows and Views, the component id should be stable as a different identifier means a different representation in storage. Changing this identifier will create a new class of component and all previous instances using the old identifier won't be accessible anymore.

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    String
    id
    The unique identifier for this component (mandatory).

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String
    description
    A description of what this component does.
    String
    name
    A human-readable name for this component (optional).

  • Element Details

    • id

      String id
      The unique identifier for this component (mandatory).

    • name

      String name
      A human-readable name for this component (optional).
      Default:
      ""

    • description

      String description
      A description of what this component does.

      Optional in general, but mandatory and non-empty for classes extending AutonomousAgent. For agents (both request-based and autonomous), the description captures the agent's purpose and expected outcome: it is injected into the model's system message and is used by other agents to decide whether to delegate or hand off to this agent. Write it as a short statement of what the agent does, when to use it, and what it produces, rather than as a procedure.

      Default:
      ""