Packages

case class Script(script: String, lang: Option[String] = None, scriptType: ScriptType = ScriptType.Source, params: Map[String, Any] = Map.empty, options: Map[String, String] = Map.empty, paramsRaw: Map[String, String] = Map.empty) extends Product with Serializable

A script that can be used in queries (ex: Painless scripting).

script

the script source

lang

the language of the script (defaults to Painless)

scriptType

the type of script (see ScriptType.Source)

params

the parameters of the script which will be automatically-serialized

options

the options for this script

paramsRaw

the parameters of the script which are already serialized

Linear Supertypes
Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Script
  2. Serializable
  3. Product
  4. Equals
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new Script(script: String, lang: Option[String] = None, scriptType: ScriptType = ScriptType.Source, params: Map[String, Any] = Map.empty, options: Map[String, String] = Map.empty, paramsRaw: Map[String, String] = Map.empty)

    script

    the script source

    lang

    the language of the script (defaults to Painless)

    scriptType

    the type of script (see ScriptType.Source)

    params

    the parameters of the script which will be automatically-serialized

    options

    the options for this script

    paramsRaw

    the parameters of the script which are already serialized

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  8. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  9. def lang(lang: String): Script

    Sets the script language.

  10. val lang: Option[String]
  11. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  13. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  14. val options: Map[String, String]
  15. def param(name: String, value: Any): Script

    Sets a parameter that will be automatically-serialized before sending to Elasticsearch.

    Sets a parameter that will be automatically-serialized before sending to Elasticsearch.

    name

    the parameter key

    value

    the parameter value as a primitive type (Double, BigInt, Seq, Map, etc.); for all the primitive types supported, see com.sksamuel.elastic4s.json.XContentBuilder#autofield; for sending objects, see paramRaw and paramObject

  16. def paramObject[T](name: String, value: T)(implicit serializer: ParamSerializer[T]): Script

    Sets a parameter with an object value, which is serialized with the given implicit serializer.

    Sets a parameter with an object value, which is serialized with the given implicit serializer.

    T

    object's type

    name

    the parameter key

    value

    the parameter value

    serializer

    the parameter serializer (see ParamSerializer)

  17. def paramRaw(name: String, value: String): Script

    Sets an already-serialized parameter.

    Sets an already-serialized parameter.

    name

    the parameter key

    value

    the parameter serialized value as a string

  18. def params(map: Map[String, Any]): Script
  19. def params(seq: Seq[(String, Any)]): Script
  20. def params(first: (String, Any), rest: (String, AnyRef)*): Script
  21. val params: Map[String, Any]
  22. def paramsObject[T](map: Map[String, T])(implicit serializer: ParamSerializer[T]): Script
  23. def paramsObject[T](seq: Seq[(String, T)])(implicit serializer: ParamSerializer[T]): Script
  24. def paramsObject[T](first: (String, T), rest: (String, T)*)(implicit serializer: ParamSerializer[T]): Script
  25. def paramsRaw(map: Map[String, String]): Script
  26. def paramsRaw(seq: Seq[(String, String)]): Script
  27. def paramsRaw(first: (String, String), rest: (String, String)*): Script
  28. val paramsRaw: Map[String, String]
  29. def productElementNames: Iterator[String]
    Definition Classes
    Product
  30. val script: String
  31. def scriptType(scriptType: ScriptType): Script
  32. def scriptType(tpe: String): Script
  33. val scriptType: ScriptType
  34. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  35. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  36. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  37. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped