Package org.springframework.data.elasticsearch.annotations

Enum Class Dynamic

java.lang.Object

java.lang.Enum<Dynamic>

org.springframework.data.elasticsearch.annotations.Dynamic

All Implemented Interfaces:

Serializable, Comparable<Dynamic>, Constable

public enum Dynamic
extends Enum<Dynamic>

Values for the dynamic mapping parameter.

Since:

4.3

Author:

Sascha Woo

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
FALSE	New fields are ignored.
INHERIT	Inherit the dynamic setting from their parent object or from the mapping type.
RUNTIME	New fields are added to the mapping as runtime fields.
STRICT	If new fields are detected, an exception is thrown and the document is rejected.
TRUE	New fields are added to the mapping.

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

TRUE

public static final Dynamic TRUE

New fields are added to the mapping.

RUNTIME

public static final Dynamic RUNTIME

New fields are added to the mapping as runtime fields. These fields are not indexed, and are loaded from _source at query time.

FALSE

public static final Dynamic FALSE

New fields are ignored. These fields will not be indexed or searchable, but will still appear in the _source field of returned hits. These fields will not be added to the mapping, and new fields must be added explicitly.

STRICT

public static final Dynamic STRICT

If new fields are detected, an exception is thrown and the document is rejected. New fields must be explicitly added to the mapping.

INHERIT

public static final Dynamic INHERIT

Inherit the dynamic setting from their parent object or from the mapping type.

Method Details

values

public static Dynamic[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static Dynamic valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

getMappedName

public String getMappedName()