Annotation Interface FunctionInfo
Describes functions.
-
Required Element Summary
Required Elements -
Optional Element Summary
Optional ElementsModifier and TypeOptional ElementDescriptionExtra information rendered at the bottom of the function docs.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.Example[]Examples of using this function that are rendered in the docs.booleanIs this an aggregation (true) or a scalar function (false).ANOTEthat's added after thedescription()in the docs.If this function implements an operator, what is its symbol?booleanWhether this function is a preview (Not ready for production environments) or not.
-
Element Details
-
operator
String operatorIf 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 butIS NULLdoesn't count.- Default:
""
-
returnType
String[] returnTypeThe type(s) this function returns. -
preview
boolean previewWhether this function is a preview (Not ready for production environments) or not.- Default:
false
-
description
String descriptionThe 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 detailedDescriptionDetailed descriptions of the function rendered in the docs. This is rendered as a single paragraph followingdescription()in the docs and is excluded from Kibana's IDE-like experience. It can contain asciidoc syntax.- Default:
""
-
note
String noteANOTEthat's added after thedescription()in the docs.- Default:
""
-
appendix
String appendixExtra information rendered at the bottom of the function docs.- Default:
""
-
isAggregation
boolean isAggregationIs this an aggregation (true) or a scalar function (false).- Default:
false
-
examples
Example[] examplesExamples of using this function that are rendered in the docs.- Default:
{}
-