Annotation Interface MapParam
Describes a function map argument represented by
MapExpression.
This is added to support search options used by FullTextFunction, and can be invoked like:
FUNCTION(a, b, {"stringArg":"value", "intArg":1, "doubleArg":2.0, "boolArg":true, "arrayArg":["a", "b"]})
Using Match function as an example, the Match function takes two required arguments,
field name and query text, it creates a MatchQuery under the cover, and the rest of the MatchQuery
options are be grouped together and provided to the Match function as an optional argument in a map format.-
Nested Class Summary
Nested Classes -
Required Element Summary
Required Elements -
Optional Element Summary
Optional ElementsModifier and TypeOptional ElementDescriptionboolean
-
Element Details
-
name
String name -
params
MapParam.MapParamEntry[] params- Default:
{}
-
description
String description- Default:
""
-
optional
boolean optional- Default:
false
-