Module org.elasticsearch.server

Package org.elasticsearch.script

Class UpdateScript

java.lang.Object

org.elasticsearch.script.UpdateScript

public abstract class UpdateScript
extends Object

A script used in the update API

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	UpdateScript.Factory

Field Summary

Fields

Modifier and Type	Field	Description
static final ScriptContext<UpdateScript.Factory>	CONTEXT	The context used to compile UpdateScript factories.
static final String[]	PARAMETERS

Constructor Summary

Constructors

Constructor	Description
UpdateScript(Map<String,Object> params, UpdateCtxMap ctxMap)

Method Summary

Modifier and Type	Method	Description
abstract void	execute()
Map<String,Object>	getCtx()	Return the update context for this script.
Map<String,Object>	getParams()	Return the parameters for this script.
Metadata	metadata()	Return the update metadata for this script

Methods inherited from class java.lang.Object

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

Field Details

PARAMETERS

public static final String[] PARAMETERS

CONTEXT

public static final ScriptContext<UpdateScript.Factory> CONTEXT

The context used to compile UpdateScript factories.

Constructor Details

UpdateScript

public UpdateScript(Map<String,Object> params,
 UpdateCtxMap ctxMap)

Method Details

getParams

public Map<String,Object> getParams()

Return the parameters for this script.

getCtx

public Map<String,Object> getCtx()

Return the update context for this script.

metadata

public Metadata metadata()

Return the update metadata for this script

execute

public abstract void execute()