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
.-
Class Summary Class Description BucketAggregationScript A script used in bucket aggregations that returns adouble
value.BucketAggregationSelectorScript A script used in bucket aggregations that returns aboolean
value.ClassPermission Checked by scripting engines to allow loading a java class.FilterScript A script implementation of a query filter.IngestConditionalScript A script used byConditionalProcessor
.IngestScript A script used by the Ingest Script Processor.JodaCompatibleZonedDateTime A wrapper around ZonedDateTime that exposes joda methods for backcompat.ParameterMap ScoreAccessor A float encapsulation that dynamically accesses the score of a document.ScoreScript A script used for adjusting the score on a per document basis.Script Script
represents used-defined input that can be used to compile and execute a script from theScriptService
based on theScriptType
.ScriptContext<FactoryType> The information necessary to compile and run a script.ScriptedMetricAggContexts ScriptedMetricAggContexts.CombineScript ScriptedMetricAggContexts.InitScript ScriptedMetricAggContexts.MapScript ScriptedMetricAggContexts.ReduceScript ScriptMetaData ScriptMetaData
is used to store user-defined scripts as part of theClusterState
using only an id as the key.ScriptMetaData.Builder A builder used to modify the currently stored scripts data held within theClusterState
.ScriptMetrics ScriptModule Manages buildingScriptService
.ScriptService ScriptStats SearchScript A generic script used for per document use cases.SignificantTermsHeuristicScoreScript A script used in significant terms heuristic scoring.SimilarityScript A script that is used to buildScriptedSimilarity
instances.SimilarityWeightScript A script that is used to compute scoring factors that are the same for all documents.StoredScriptSource StoredScriptSource
represents user-defined parameters for a script saved in theClusterState
.TemplateScript A string template rendered as a script.TermsSetQueryScript UpdateScript An update script. -
Enum Summary Enum Description ScriptType ScriptType represents the way a script is stored and retrieved from theScriptService
. -
Exception Summary Exception Description GeneralScriptException Deprecated. Use ScriptException for exceptions from the scripting engine, otherwise use a more appropriate exception (e.g.ScriptException Exception from a scripting engine.