Package org.elasticsearch.script
package org.elasticsearch.script
Support for running user provided scripts (in the request, in cluster state, etc) in portions of various requests
(
FunctionScoreQuery, Aggregation,
UpdateAction, etc). Pluggable via implementing ScriptPlugin.-
Interface SummaryInterfaceDescriptionA factory to construct stateful
AggregationScriptfactories for a specific index.A factory to constructAggregationScriptinstances.To be implemented byScoreScriptwhich can provided anExplanationof the score This is currently not used inside elasticsearch but it is used, see for example here: https://github.com/elastic/elasticsearch/issues/8561A factory to constructFieldScriptinstances.A factory to construct statefulFilterScriptfactories for a specific index.A factory to constructFilterScriptinstances.A factory to construct statefulNumberSortScriptfactories for a specific index.A factory to constructNumberSortScriptinstances.A factory to construct statefulScoreScriptfactories for a specific index.A factory to constructScoreScriptinstances.Takes a Script definition and returns a compiled script factoryA script language implementation.Contains utility methods for compiled scripts without impacting concrete script signaturesA factory to construct statefulStringSortScriptfactories for a specific index.A factory to constructStringSortScriptinstances.A factory to construct statefulTermsSetQueryScriptfactories for a specific index.A factory to constructTermsSetQueryScriptinstances. -
Class SummaryClassDescriptionAbstract base for scripts to execute to build scripted fields.Common base class for script field scripts that return long values.A script used in bucket aggregations that returns a
doublevalue.A script used in bucket aggregations that returns abooleanvalue.Checked by scripting engines to allow loading a java class.Temporary parse method that takes into account the date format.DynamicMap is used to wrap a Map for a script parameter.A script to produce dynamic values for return fields.A script implementation of a query filter.Script producing geo points.A script used byConditionalProcessor.A script used by the Ingest Script Processor.Script producing IP addresses.A wrapper around ZonedDateTime that exposes joda methods for backcompat.A script used for adjusting the score on a per document basis.A helper to take in an explanation from a script and turn it into anExplanationScriptrepresents used-defined input that can be used to compile and execute a script from theScriptServicebased on theScriptType.Script cache and compilation rate limiter.ScriptContext<FactoryType>The information necessary to compile and run a script.The allowable types, languages and their corresponding contexts.ScriptMetadatais used to store user-defined scripts as part of theClusterStateusing only an id as the key.A builder used to modify the currently stored scripts data held within theClusterState.Manages buildingScriptService.A script used in significant terms heuristic scoring.A script that is used to buildScriptedSimilarityinstances.A script that is used to compute scoring factors that are the same for all documents.StoredScriptSourcerepresents user-defined parameters for a script saved in theClusterState.A string template rendered as a script.An update script. -
Enum Class SummaryEnum ClassDescriptionScriptType represents the way a script is stored and retrieved from the
ScriptService. -
Exception SummaryExceptionDescriptionDeprecated.Use ScriptException for exceptions from the scripting engine, otherwise use a more appropriate exception (e.g.Exception from a scripting engine.