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.Whether this function applies to particular versions of Elasticsearch.intAdjusts 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.Example[]Examples of using this function that are rendered in the docs.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.The position the function can appear in the language.
-
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
-
appliesTo
FunctionAppliesTo[] appliesToWhether this function applies to particular versions of Elasticsearch.- Default:
{}
-
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:
""
-
depthOffset
int depthOffsetAdjusts documentation heading level (0=standard, 1=subheading, etc). Used to create logical nesting between related functions.- Default:
0
-
type
FunctionType typeThe position the function can appear in the language.- Default:
SCALAR
-
examples
Example[] examplesExamples of using this function that are rendered in the docs.- Default:
{}
-