org.elasticsearch.script

Interface ExecutableScript

All Known Subinterfaces:

ExplainableSearchScript, LeafSearchScript

All Known Implementing Classes:

AbstractDoubleSearchScript, AbstractExecutableScript, AbstractLongSearchScript, AbstractSearchScript

public interface ExecutableScript

An executable script, can't be used concurrently.

Method Summary

Modifier and Type	Method and Description
java.lang.Object	run() Executes the script.
void	setNextVar(java.lang.String name, java.lang.Object value) Sets a runtime script parameter.
default java.lang.Object	unwrap(java.lang.Object value) Unwraps a possible script value.

Method Detail

setNextVar

void setNextVar(java.lang.String name,
                java.lang.Object value)

Sets a runtime script parameter.

Note that this method may be slow, involving put() and get() calls to a hashmap or similar.

Parameters:

name - parameter name

value - parameter value

run

java.lang.Object run()

Executes the script.

unwrap

default java.lang.Object unwrap(java.lang.Object value)

Unwraps a possible script value. For example, when passing vars and expecting the returned value to be part of the vars. Javascript and Python need this but other scripting engines just return the values passed in.