Module org.elasticsearch.server

Package org.elasticsearch.script

Class Metadata

java.lang.Object

org.elasticsearch.script.Metadata

Direct Known Subclasses:

ReindexMetadata, UpdateByQueryMetadata, UpdateMetadata

public class Metadata
extends Object

Ingest and update metadata available to write scripts. Provides a map-like interface for backwards compatibility with the ctx map. - put(String, Object) - get(String) - remove(String) - containsKey(String) - containsValue(Object) - keySet() for iteration - size() - isAvailable(String) for determining if a key is a metadata key Provides getters and setters for script usage. Validates all updates whether originating in map-like interface or setters.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	Metadata.FieldProperty<T>	The properties of a metadata field.
static enum	Metadata.MapOperation	The operation being performed on the value in the map.

Field Summary

Fields

Modifier and Type	Field	Description
protected static final Metadata.FieldProperty<?>	BAD_KEY
protected static final String	DYNAMIC_TEMPLATES
protected static final String	ID
protected static final String	IF_PRIMARY_TERM
protected static final String	IF_SEQ_NO
protected static final String	INDEX
static Metadata.FieldProperty<Number>	LongField
protected final Map<String,Object>	map
protected static final String	NOW
static Metadata.FieldProperty<Object>	ObjectField
protected static final String	OP
protected final Map<String,Metadata.FieldProperty<?>>	properties
protected static final String	ROUTING
static Metadata.FieldProperty<String>	StringField
protected static final String	TYPE
protected static final String	VERSION
protected static final String	VERSION_TYPE

Constructor Summary

Constructors

Constructor	Description
Metadata(Map<String,Object> map, Map<String,Metadata.FieldProperty<?>> properties)

Method Summary

Modifier and Type	Method	Description
Metadata	clone()
boolean	containsKey(String key)	Does the metadata contain the key?
boolean	containsValue(Object value)	Does the metadata contain the value.
boolean	equals(Object o)
Object	get(String key)	Get the value associated with
Map<String,String>	getDynamicTemplates()
String	getId()
Number	getIfPrimaryTerm()
Number	getIfSeqNo()
String	getIndex()
Map<String,Object>	getMap()	Get the backing map, if modified then the guarantees of this class may not hold
ZonedDateTime	getNow()
protected Number	getNumber(String key)	Get the Number associated with key, or null
String	getOp()
String	getRouting()
protected String	getString(String key)	Get the String version of the value associated with key, or null
long	getVersion()
String	getVersionType()
int	hashCode()
boolean	isAvailable(String key)	Is this key a Metadata key? A remove(java.lang.String)d key would return false for containsKey(String) but true for this call.
Set<String>	keySet()	Return the list of keys with mappings
Object	put(String key, Object value)	Create the mapping from key to value.
Object	remove(String key)	Remove the mapping associated with
void	setId(String id)
void	setIndex(String index)
void	setOp(String op)
void	setRouting(String routing)
void	setVersion(long version)
void	setVersionType(String versionType)
int	size()	The number of metadata keys currently mapped.
static BiConsumer<String,String>	stringSetValidator(Set<String> valid)
protected void	validateMetadata()	Check that all metadata map contains only valid metadata and no extraneous keys

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Details

INDEX

protected static final String INDEX

See Also:

• Constant Field Values

ID

protected static final String ID

See Also:

• Constant Field Values

ROUTING

protected static final String ROUTING

See Also:

• Constant Field Values

VERSION_TYPE

protected static final String VERSION_TYPE

See Also:

• Constant Field Values

VERSION

protected static final String VERSION

See Also:

• Constant Field Values

TYPE

protected static final String TYPE

See Also:

• Constant Field Values

NOW

protected static final String NOW

See Also:

• Constant Field Values

OP

protected static final String OP

See Also:

• Constant Field Values

IF_SEQ_NO

protected static final String IF_SEQ_NO

See Also:

• Constant Field Values

IF_PRIMARY_TERM

protected static final String IF_PRIMARY_TERM

See Also:

• Constant Field Values

DYNAMIC_TEMPLATES

protected static final String DYNAMIC_TEMPLATES

See Also:

• Constant Field Values

ObjectField

public static Metadata.FieldProperty<Object> ObjectField

StringField

public static Metadata.FieldProperty<String> StringField

LongField

public static Metadata.FieldProperty<Number> LongField

map

protected final Map<String,Object> map

properties

protected final Map<String,Metadata.FieldProperty<?>> properties

BAD_KEY

protected static final Metadata.FieldProperty<?> BAD_KEY

Constructor Details

Metadata

public Metadata(Map<String,Object> map,
 Map<String,Metadata.FieldProperty<?>> properties)

Method Details

validateMetadata

protected void validateMetadata()

Check that all metadata map contains only valid metadata and no extraneous keys

getIndex

public String getIndex()

setIndex

public void setIndex(String index)

getId

public String getId()

setId

public void setId(String id)

getRouting

public String getRouting()

setRouting

public void setRouting(String routing)

getVersionType

public String getVersionType()

setVersionType

public void setVersionType(String versionType)

getVersion

public long getVersion()

setVersion

public void setVersion(long version)

getNow

public ZonedDateTime getNow()

getOp

public String getOp()

setOp

public void setOp(String op)

getIfSeqNo

public Number getIfSeqNo()

getIfPrimaryTerm

public Number getIfPrimaryTerm()

getDynamicTemplates

public Map<String,String> getDynamicTemplates()

getString

protected String getString(String key)

Get the String version of the value associated with key, or null

getNumber

protected Number getNumber(String key)

Get the Number associated with key, or null

Throws:

IllegalArgumentException - if the value is not a Number

isAvailable

public boolean isAvailable(String key)

Is this key a Metadata key? A remove(java.lang.String)d key would return false for containsKey(String) but true for this call.

put

public Object put(String key,
 Object value)

Create the mapping from key to value.

Throws:

IllegalArgumentException - if isAvailable(String) is false or the key cannot be updated to the value.

containsKey

public boolean containsKey(String key)

Does the metadata contain the key?

containsValue

public boolean containsValue(Object value)

Does the metadata contain the value.

get

public Object get(String key)

Get the value associated with

remove

public Object remove(String key)

Remove the mapping associated with

Throws:

IllegalArgumentException - if isAvailable(String) is false or the key cannot be removed.

keySet

public Set<String> keySet()

Return the list of keys with mappings

size

public int size()

The number of metadata keys currently mapped.

clone

public Metadata clone()

Overrides:

clone in class Object

getMap

public Map<String,Object> getMap()

Get the backing map, if modified then the guarantees of this class may not hold

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

stringSetValidator

public static BiConsumer<String,String> stringSetValidator(Set<String> valid)