org.elasticsearch.script

Class Script

java.lang.Object

org.elasticsearch.script.Script

All Implemented Interfaces:

Streamable, ToXContent

Direct Known Subclasses:

Template

public class Script
extends Object
implements ToXContent, Streamable

Script holds all the parameters necessary to compile or find in cache and then execute a script.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Script.ScriptField
static class	Script.ScriptParseException

Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

Fields

Modifier and Type	Field and Description
static ScriptService.ScriptType	DEFAULT_TYPE

Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Modifier	Constructor and Description
	Script(String script) Constructor for simple inline script.
	Script(String script, ScriptService.ScriptType type, String lang, Map<String,? extends Object> params) Constructor for Script.
protected	Script(String script, String lang) For sub-classes to use to override the default language

Method Summary

Modifier and Type	Method and Description
protected void	doReadFrom(StreamInput in)
protected void	doWriteTo(StreamOutput out)
boolean	equals(Object obj)
String	getLang() Method for getting language.
Map<String,Object>	getParams() Method for getting the parameters.
String	getScript() Method for getting the script.
ScriptService.ScriptType	getType() Method for getting the type.
int	hashCode()
static Script	parse(Map<String,Object> config, boolean removeMatchedEntries, ParseFieldMatcher parseFieldMatcher)
static Script	parse(XContentParser parser, ParseFieldMatcher parseFieldMatcher)
void	readFrom(StreamInput in)
static Script	readScript(StreamInput in)
protected XContentBuilder	scriptFieldToXContent(String script, ScriptService.ScriptType type, XContentBuilder builder, ToXContent.Params builderParams)
String	toString()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params builderParams)
void	writeTo(StreamOutput out)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

DEFAULT_TYPE

public static final ScriptService.ScriptType DEFAULT_TYPE

Constructor Detail

Script

public Script(String script)

Constructor for simple inline script. The script will have no lang or params set.

Parameters:

script - The inline script to execute.

Script

protected Script(String script,
                 String lang)

For sub-classes to use to override the default language

Script

public Script(String script,
              ScriptService.ScriptType type,
              @Nullable
              String lang,
              @Nullable
              Map<String,? extends Object> params)

Constructor for Script.

Parameters:

script - The cache key of the script to be compiled/executed. For inline scripts this is the actual script source code. For indexed scripts this is the id used in the request. For on file scripts this is the file name.

type - The type of script -- dynamic, indexed, or file.

lang - The language of the script to be compiled/executed.

params - The map of parameters the script will be executed with.

Method Detail

getScript

public String getScript()

Method for getting the script.

Returns:

The cache key of the script to be compiled/executed. For dynamic scripts this is the actual script source code. For indexed scripts this is the id used in the request. For on disk scripts this is the file name.

getType

public ScriptService.ScriptType getType()

Method for getting the type.

Returns:

The type of script -- inline, indexed, or file.

getLang

public String getLang()

Method for getting language.

Returns:

The language of the script to be compiled/executed.

getParams

public Map<String,Object> getParams()

Method for getting the parameters.

Returns:

The map of parameters the script will be executed with.

readFrom

public final void readFrom(StreamInput in)
                    throws IOException

Specified by:

readFrom in interface Streamable

Throws:

IOException

doReadFrom

protected void doReadFrom(StreamInput in)
                   throws IOException

Throws:

IOException

writeTo

public final void writeTo(StreamOutput out)
                   throws IOException

Specified by:

writeTo in interface Streamable

Throws:

IOException

doWriteTo

protected void doWriteTo(StreamOutput out)
                  throws IOException

Throws:

IOException

toXContent

public final XContentBuilder toXContent(XContentBuilder builder,
                                        ToXContent.Params builderParams)
                                 throws IOException

Specified by:

toXContent in interface ToXContent

Throws:

IOException

scriptFieldToXContent

protected XContentBuilder scriptFieldToXContent(String script,
                                                ScriptService.ScriptType type,
                                                XContentBuilder builder,
                                                ToXContent.Params builderParams)
                                         throws IOException

Throws:

IOException

readScript

public static Script readScript(StreamInput in)
                         throws IOException

Throws:

IOException

parse

public static Script parse(Map<String,Object> config,
                           boolean removeMatchedEntries,
                           ParseFieldMatcher parseFieldMatcher)

parse

public static Script parse(XContentParser parser,
                           ParseFieldMatcher parseFieldMatcher)
                    throws IOException

Throws:

IOException

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object