Package com.scaleoutsoftware.modules.abstractions

Annotation Interface PropertyAiMetadata

@Retention(RUNTIME) public @interface PropertyAiMetadata
Annotate a DigitalTwinBase class implementation's properties with PropertyAiMetadata to provide additional context about a DigitalTwin instance for AI Agents.

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    String
    type
    The type of the property.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String
    description
    The description of the property.
    String
    maxValue
    The maximum value reported by the property.
    String
    minValue
    The minimum value reported by the property.
    String
    units
    The units used by the property.

  • Element Details

    • type

      String type
      The type of the property.
      Returns:
      the type of the property.

    • description

      String description
      The description of the property.
      Returns:
      the description of the property.
      Default:
      ""

    • units

      String units
      The units used by the property.
      Returns:
      the units used by the property.
      Default:
      ""

    • minValue

      String minValue
      The minimum value reported by the property.
      Returns:
      the minimum value reported by the property.
      Default:
      ""

    • maxValue

      String maxValue
      The maximum value reported by the property.
      Returns:
      the maximum value reported by the property.
      Default:
      ""