org.elasticsearch.script

Class ScriptMetaData.Builder

java.lang.Object

org.elasticsearch.script.ScriptMetaData.Builder

Enclosing class:

ScriptMetaData

public static final class ScriptMetaData.Builder
extends java.lang.Object

A builder used to modify the currently stored scripts data held within the ClusterState. Scripts can be added or deleted, then built to generate a new Map of scripts that will be used to update the current ClusterState.

Constructor Summary

Constructors

Constructor and Description
Builder(ScriptMetaData previous)

Method Summary

Modifier and Type	Method and Description
ScriptMetaData	build()
ScriptMetaData.Builder	deleteScript(java.lang.String id, java.lang.String lang) Delete a script from the existing stored scripts.
ScriptMetaData.Builder	storeScript(java.lang.String id, StoredScriptSource source) Add a new script to the existing stored scripts.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder(ScriptMetaData previous)

Parameters:

previous - The current ScriptMetaData or null if there is no existing ScriptMetaData.

Method Detail

storeScript

public ScriptMetaData.Builder storeScript(java.lang.String id,
                                          StoredScriptSource source)

Add a new script to the existing stored scripts. The script will be added under both the new namespace and the deprecated namespace, so that look ups under the deprecated namespace will continue to work. Should a script already exist under the new namespace using a different language, it will be replaced and a deprecation warning will be issued. The replaced script will still exist under the deprecated namespace and can continue to be looked up this way until it is deleted.

Take for example script 'A' with lang 'L0' and data 'D0'. If we add script 'A' to the empty set, the scripts Map will be ["A" -- D0, "A#L0" -- D0]. If a script 'A' with lang 'L1' and data 'D1' is then added, the scripts Map will be ["A" -- D1, "A#L1" -- D1, "A#L0" -- D0].

Parameters:

id - The user-specified id to use for the look up.

source - The user-specified stored script data held in StoredScriptSource.

deleteScript

public ScriptMetaData.Builder deleteScript(java.lang.String id,
                                           java.lang.String lang)

Delete a script from the existing stored scripts. The script will be removed from the new namespace if the script language matches the current script under the same id or if the script language is null. The script will be removed from the deprecated namespace on any delete either using using the specified lang parameter or the language found from looking up the script in the new namespace.

Take for example a scripts Map with {"A" -- D1, "A#L1" -- D1, "A#L0" -- D0}. If a script is removed specified by an id 'A' and lang null then the scripts Map will be {"A#L0" -- D0}. To remove the final script, the deprecated namespace must be used, so an id 'A' and lang 'L0' would need to be specified.

Parameters:

id - The user-specified id to use for the look up.

lang - The user-specified language to use for the look up if using the deprecated namespace, otherwise null.

build

public ScriptMetaData build()

Returns:

A ScriptMetaData with the updated Map of scripts.