Module org.elasticsearch.server

Package org.elasticsearch.script

Class UpdateByQueryScript

java.lang.Object

org.elasticsearch.script.WriteScript

org.elasticsearch.script.UpdateByQueryScript

public abstract class UpdateByQueryScript
extends WriteScript

A script used by the update by query api

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	UpdateByQueryScript.Factory

Field Summary

Fields

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

Fields inherited from class org.elasticsearch.script.WriteScript

ctxMap

Constructor Summary

Constructors

Constructor	Description
UpdateByQueryScript(Map<String,Object> params, CtxMap<UpdateByQueryMetadata> ctxMap)

Method Summary

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

Methods inherited from class org.elasticsearch.script.WriteScript

field, getCtx, metadata

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<UpdateByQueryScript.Factory> CONTEXT

The context used to compile UpdateByQueryScript factories.

Constructor Details

UpdateByQueryScript

public UpdateByQueryScript(Map<String,Object> params,
 CtxMap<UpdateByQueryMetadata> ctxMap)

Method Details

getParams

public Map<String,Object> getParams()

Return the parameters for this script.

execute

public abstract void execute()