Module org.mule.sdk.api
Package org.mule.sdk.api.annotation.metadata

Annotation Interface MetadataKeyPart

@Target(FIELD) @Retention(RUNTIME) @Documented @MinMuleVersion("4.5.0") public @interface MetadataKeyPart
Marks a field inside a POJO that represents a composed MetadataKey as one of the parts of that composed MetadataKey.

Multiple MetadataKeyParts describe a POJO that can be annotated with MetadataKeyId and also injected into a InputTypeResolver or OutputTypeResolver.

MetadataKeyPart annotated fields must be of type String

Since:
1.0

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    int
    order
    The resolution order of this key part, starting from 1.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    boolean
    providedByKeyResolver
     

  • Element Details

    • order

      int order
      The resolution order of this key part, starting from 1.
      Returns:
      the resolution order of this key part during the building of the MetadataKeyId annotated parameter corresponding to this MetadataKeyPart.

    • providedByKeyResolver

      boolean providedByKeyResolver
      Returns:
      whether or not this MetadataKeyPart will be provided by the TypeKeysResolver associated to the container of this part, or if this part has no predefined values and has to be provided by the user entirely.
      Default:
      true