Package org.elasticsearch.script

Class TemplateScript

java.lang.Object
org.elasticsearch.script.TemplateScript
public abstract class TemplateScript
extends java.lang.Object
A string template rendered as a script.

  • Nested Class Summary

    Nested Classes
    Modifier and Type Class Description
    static interface  TemplateScript.Factory  

  • Field Summary

    Fields
    Modifier and Type Field Description
    static ScriptContext<TemplateScript.Factory> CONTEXT  
    static ScriptContext<TemplateScript.Factory> INGEST_CONTEXT  
    static java.lang.String[] PARAMETERS  

  • Constructor Summary

    Constructors
    Constructor Description
    TemplateScript​(java.util.Map<java.lang.String,​java.lang.Object> params)  

  • Method Summary

    Modifier and Type Method Description
    abstract java.lang.String execute()
    Run a template and return the resulting string, encoded in utf8 bytes.
    java.util.Map<java.lang.String,​java.lang.Object> getParams()
    Return the parameters for this script.

    Methods inherited from class java.lang.Object

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

  • Field Details

  • Constructor Details

    • TemplateScript

      public TemplateScript​(java.util.Map<java.lang.String,​java.lang.Object> params)

  • Method Details

    • getParams

      public java.util.Map<java.lang.String,​java.lang.Object> getParams()
      Return the parameters for this script.

    • execute

      public abstract java.lang.String execute()
      Run a template and return the resulting string, encoded in utf8 bytes.