org.elasticsearch.script

Enum ScriptContext.Standard

java.lang.Object

java.lang.Enum<ScriptContext.Standard>

org.elasticsearch.script.ScriptContext.Standard

All Implemented Interfaces:

Serializable, Comparable<ScriptContext.Standard>, ScriptContext

Enclosing interface:

ScriptContext

public static enum ScriptContext.Standard
extends Enum<ScriptContext.Standard>
implements ScriptContext

Standard operations that make use of scripts as part of their execution. Note that the suggest api is considered part of search for simplicity, as well as the percolate api.

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.script.ScriptContext

ScriptContext.Plugin, ScriptContext.Standard

Enum Constant Summary

Enum Constants

Enum Constant and Description
AGGS
MAPPING
SEARCH
UPDATE

Method Summary

Methods

Modifier and Type	Method and Description
String	getKey()
String	toString()
static ScriptContext.Standard	valueOf(String name) Returns the enum constant of this type with the specified name.
static ScriptContext.Standard[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

AGGS

public static final ScriptContext.Standard AGGS

MAPPING

public static final ScriptContext.Standard MAPPING

SEARCH

public static final ScriptContext.Standard SEARCH

UPDATE

public static final ScriptContext.Standard UPDATE

Method Detail

values

public static ScriptContext.Standard[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ScriptContext.Standard c : ScriptContext.Standard.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ScriptContext.Standard valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getKey

public String getKey()

Specified by:

getKey in interface ScriptContext

Returns:

the name of the operation

toString

public String toString()

Overrides:

toString in class Enum<ScriptContext.Standard>