Package org.opensearch.script

package org.opensearch.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.

Related Packages

Package	Description
org.opensearch	A distributed RESTful search engine.

Class	Description
AggregationScript	Scripts for aggregations
AggregationScript.Factory	A factory to construct stateful AggregationScript factories for a specific index.
AggregationScript.LeafFactory	A factory to construct AggregationScript instances.
BucketAggregationScript	A script used in bucket aggregations that returns a double value.
BucketAggregationScript.Factory	Factory for bucket agg script
BucketAggregationSelectorScript	A script used in bucket aggregations that returns a boolean value.
BucketAggregationSelectorScript.Factory	Factory for bucket agg selector script
ClassPermission	Checked by scripting engines to allow loading a java class.
DynamicMap	DynamicMap is used to wrap a Map for a script parameter.
ExplainableScoreScript	To be implemented by ScoreScript which can provided an Explanation of the score This is currently not used inside opensearch but it is used, see for example here: https://github.com/elastic/elasticsearch/issues/8561
FieldScript	A script to produce dynamic values for return fields.
FieldScript.Factory	Factory for field script
FieldScript.LeafFactory	A factory to construct FieldScript instances.
FilterScript	A script implementation of a query filter.
FilterScript.Factory	A factory to construct stateful FilterScript factories for a specific index.
FilterScript.LeafFactory	A factory to construct FilterScript instances.
GeneralScriptException	Deprecated. Use ScriptException for exceptions from the scripting engine, otherwise use a more appropriate exception (e.g.
IngestConditionalScript	A script used by ConditionalProcessor.
IngestConditionalScript.Factory	Factory for ingest condition script
IngestScript	A script used by the Ingest Script Processor.
IngestScript.Factory	Factory for ingest script
JodaCompatibleZonedDateTime	A wrapper around ZonedDateTime that exposes joda methods for backcompat.
NumberSortScript	Script for number sorts
NumberSortScript.Factory	A factory to construct stateful NumberSortScript factories for a specific index.
NumberSortScript.LeafFactory	A factory to construct NumberSortScript instances.
ScoreScript	A script used for adjusting the score on a per document basis.
ScoreScript.ExplanationHolder	A helper to take in an explanation from a script and turn it into an Explanation
ScoreScript.Factory	A factory to construct stateful ScoreScript factories for a specific index.
ScoreScript.LeafFactory	A factory to construct ScoreScript instances.
ScoreScriptUtils	Utilities for scoring scripts
ScoreScriptUtils.DecayDateExp	Exponential date decay
ScoreScriptUtils.DecayDateGauss	Gaussian date decay
ScoreScriptUtils.DecayDateLinear	Linear date decay
ScoreScriptUtils.DecayGeoExp	Exponential geo decay
ScoreScriptUtils.DecayGeoGauss	Gaussian geo decay
ScoreScriptUtils.DecayGeoLinear	**** Decay functions on geo field
ScoreScriptUtils.DecayNumericExp	Exponential numeric decay
ScoreScriptUtils.DecayNumericGauss	Gaussian numeric decay
ScoreScriptUtils.DecayNumericLinear	Linear numeric decay
ScoreScriptUtils.RandomScoreDoc	random score based on the internal Lucene document Ids
ScoreScriptUtils.RandomScoreField	random score based on the documents' values of the given field
ScoreScriptUtils.SumTotalTermFreq	Retrieves the sum of total term frequencies within a field.
ScoreScriptUtils.TermFreq	Retrieves the term frequency within a field for a specific term.
ScoreScriptUtils.TotalTermFreq	Retrieves the total term frequency within a field for a specific term.
Script	Script represents used-defined input that can be used to compile and execute a script from the ScriptService based on the ScriptType.
ScriptCache	Script cache and compilation rate limiter.
ScriptCache.CompilationRate	Tracking compilation rate
ScriptCacheStats	Deprecated. This class is deprecated in favor of ScriptStats and ScriptContextStats.
ScriptContext<FactoryType>	The information necessary to compile and run a script.
ScriptContextInfo	Information about a script context
ScriptContextInfo.ScriptMethodInfo	Script method information
ScriptContextInfo.ScriptMethodInfo.ParameterInfo	Parameter information
ScriptContextStats	Stats for a script context
ScriptedMetricAggContexts	Contexts for scripted metric aggregations
ScriptedMetricAggContexts.CombineScript	Base combination script
ScriptedMetricAggContexts.CombineScript.Factory	Factory for a scripted metric agg context
ScriptedMetricAggContexts.InitScript	Base initialization script
ScriptedMetricAggContexts.InitScript.Factory	Factory for a scripted metric agg context
ScriptedMetricAggContexts.MapScript	Base map script
ScriptedMetricAggContexts.MapScript.Factory	Factory for a scripted metric agg factory
ScriptedMetricAggContexts.MapScript.LeafFactory	Factory for a scripted metric agg context
ScriptedMetricAggContexts.ReduceScript	Base reduce script
ScriptedMetricAggContexts.ReduceScript.Factory	Factory for a scripted metric agg context
ScriptEngine	A script language implementation.
ScriptException	Exception from a scripting engine.
ScriptException.Position	Position data
ScriptFactory	Contains utility methods for compiled scripts without impacting concrete script signatures
ScriptLanguagesInfo	The allowable types, languages and their corresponding contexts.
ScriptMetadata	ScriptMetadata is used to store user-defined scripts as part of the ClusterState using only an id as the key.
ScriptMetadata.Builder	A builder used to modify the currently stored scripts data held within the ClusterState.
ScriptMetrics	Metrics for scripts
ScriptModule	Manages building ScriptService.
ScriptService	Service for scripting
ScriptStats	Stats for scripts
ScriptType	ScriptType represents the way a script is stored and retrieved from the ScriptService.
SearchScript	A script used by the Search Script Processor.
SearchScript.Factory	Factory for search script
SignificantTermsHeuristicScoreScript	A script used in significant terms heuristic scoring.
SignificantTermsHeuristicScoreScript.Factory	Factory for a significant terms heuristic score script
SimilarityScript	A script that is used to build ScriptedSimilarity instances.
SimilarityScript.Factory	Factory for a similarity script
SimilarityWeightScript	A script that is used to compute scoring factors that are the same for all documents.
SimilarityWeightScript.Factory	Factory for a similarity weight script
StoredScriptSource	StoredScriptSource represents user-defined parameters for a script saved in the ClusterState.
StringSortScript	Script for sorting strings
StringSortScript.Factory	A factory to construct stateful StringSortScript factories for a specific index.
StringSortScript.LeafFactory	A factory to construct StringSortScript instances.
TemplateScript	A string template rendered as a script.
TemplateScript.Factory	Factory for a template script
TermsSetQueryScript	Script for terms set query
TermsSetQueryScript.Factory	A factory to construct stateful TermsSetQueryScript factories for a specific index.
TermsSetQueryScript.LeafFactory	A factory to construct TermsSetQueryScript instances.
UpdateScript	An update script.
UpdateScript.Factory	Factory for an update script