org.elasticsearch.script

クラス Script

java.lang.Object

org.elasticsearch.script.Script

すべての実装されたインタフェース:

Streamable, ToXContent

直系の既知のサブクラス:

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.

ネストされたクラスのサマリー

ネストされたクラス

修飾子とタイプ	クラスと説明
static interface	Script.ScriptField
static class	Script.ScriptParseException

インタフェースから継承されたネストされたクラス/インタフェース org.elasticsearch.common.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

フィールドのサマリー

フィールド

修飾子とタイプ	フィールドと説明
static ScriptService.ScriptType	DEFAULT_TYPE

インタフェースから継承されたフィールド org.elasticsearch.common.xcontent.ToXContent

EMPTY_PARAMS

コンストラクタのサマリー

コンストラクタ

修飾子	コンストラクタと説明
	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

メソッドのサマリー

修飾子とタイプ	メソッドと説明
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)

クラスから継承されたメソッド java.lang.Object

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

フィールドの詳細

DEFAULT_TYPE

public static final ScriptService.ScriptType DEFAULT_TYPE

コンストラクタの詳細

Script

public Script(String script)

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

パラメータ:

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.

パラメータ:

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.

メソッドの詳細

getScript

public String getScript()

Method for getting the script.

戻り値:

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.

戻り値:

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

getLang

public String getLang()

Method for getting language.

戻り値:

The language of the script to be compiled/executed.

getParams

public Map<String,Object> getParams()

Method for getting the parameters.

戻り値:

The map of parameters the script will be executed with.

readFrom

public final void readFrom(StreamInput in)
                    throws IOException

定義:

readFrom インタフェース内 Streamable

例外:

IOException

doReadFrom

protected void doReadFrom(StreamInput in)
                   throws IOException

例外:

IOException

writeTo

public final void writeTo(StreamOutput out)
                   throws IOException

定義:

writeTo インタフェース内 Streamable

例外:

IOException

doWriteTo

protected void doWriteTo(StreamOutput out)
                  throws IOException

例外:

IOException

toXContent

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

定義:

toXContent インタフェース内 ToXContent

例外:

IOException

scriptFieldToXContent

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

例外:

IOException

readScript

public static Script readScript(StreamInput in)
                         throws IOException

例外:

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

例外:

IOException

hashCode

public int hashCode()

オーバーライド:

hashCode クラス内 Object

equals

public boolean equals(Object obj)

オーバーライド:

equals クラス内 Object

toString

public String toString()

オーバーライド:

toString クラス内 Object