Package io.kestra.core.models.annotations

Annotation Interface Example

@Documented @Inherited @Retention(RUNTIME) @Target({TYPE,ANNOTATION_TYPE}) @Repeatable(Examples.class) public @interface Example

  • Element Details

    • title

      String title
      Returns:
      The short description of current element
      Default:
      ""

    • code

      String[] code
      Returns:
      The code of current element
      Default:
      {""}

    • lang

      String lang
      Returns:
      The language of current element
      Default:
      "yaml"

    • full

      boolean full
      Returns:
      If the example is full (in this case, don't auto add type and id property
      Default:
      false