Annotation Interface FunctionInfo


@Retention(RUNTIME) @Target(CONSTRUCTOR) public @interface FunctionInfo
Describes functions.
  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    The type(s) this function returns.
  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    Extra information rendered at the bottom of the function docs.
    Whether this function applies to particular versions of Elasticsearch.
    int
    Adjusts documentation heading level (0=standard, 1=subheading, etc).
    The description of the function rendered in the docs and kibana's json files that drive their IDE-like experience.
    Detailed descriptions of the function rendered in the docs.
    Examples of using this function that are rendered in the docs.
    A NOTE that's added after the description() in the docs.
    If this function implements an operator, what is its symbol?
    boolean
    Whether this function is a preview (Not ready for production environments) or not.
    The position the function can appear in the language.
  • Element Details

    • operator

      String operator
      If this function implements an operator, what is its symbol?

      This exists entirely to add to the Kibana function definition json files. Kibana thinks of something as an operator if the text that triggers it is not the name of the function. So + is an operator but IS NULL doesn't count.

      Default:
      ""
    • returnType

      String[] returnType
      The type(s) this function returns.
    • preview

      boolean preview
      Whether this function is a preview (Not ready for production environments) or not.
      Default:
      false
    • appliesTo

      FunctionAppliesTo[] appliesTo
      Whether this function applies to particular versions of Elasticsearch.
      Default:
      {}
    • description

      String description
      The description of the function rendered in the docs and kibana's json files that drive their IDE-like experience. These should be complete sentences but can contain asciidoc syntax. It is rendered as a single paragraph.
      Default:
      ""
    • detailedDescription

      String detailedDescription
      Detailed descriptions of the function rendered in the docs. This is rendered as a single paragraph following description() in the docs and is excluded from Kibana's IDE-like experience. It can contain asciidoc syntax.
      Default:
      ""
    • note

      String note
      A NOTE that's added after the description() in the docs.
      Default:
      ""
    • appendix

      String appendix
      Extra information rendered at the bottom of the function docs.
      Default:
      ""
    • depthOffset

      int depthOffset
      Adjusts documentation heading level (0=standard, 1=subheading, etc). Used to create logical nesting between related functions.
      Default:
      0
    • type

      The position the function can appear in the language.
      Default:
      SCALAR
    • examples

      Example[] examples
      Examples of using this function that are rendered in the docs.
      Default:
      {}