Module org.elasticsearch.server

Package org.elasticsearch.script

Class WriteScript

java.lang.Object

org.elasticsearch.script.WriteScript

Direct Known Subclasses:

IngestScript, ReindexScript, UpdateByQueryScript, UpdateScript

public abstract class WriteScript
extends Object

Abstract base class for scripts that write documents. These scripts provide ctx for backwards compatibility and expose Metadata.

Field Summary

Fields

Modifier and Type	Field	Description
protected final CtxMap<?>	ctxMap

Constructor Summary

Constructors

Constructor	Description
WriteScript(CtxMap<?> ctxMap)

Method Summary

Modifier and Type	Method	Description
WriteField	field(String path)
Map<String,Object>	getCtx()	Provides backwards compatibility access to ctx
Metadata	metadata()	Return the metadata for this script

Methods inherited from class java.lang.Object

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

Field Details

ctxMap

protected final CtxMap<?> ctxMap

Constructor Details

WriteScript

public WriteScript(CtxMap<?> ctxMap)

Method Details

getCtx

public Map<String,Object> getCtx()

Provides backwards compatibility access to ctx

metadata

public Metadata metadata()

Return the metadata for this script

field

public WriteField field(String path)