Module org.elasticsearch.server

Package org.elasticsearch.index.mapper

Record Class FieldMapper.BuilderParams

java.lang.Object

java.lang.Record

org.elasticsearch.index.mapper.FieldMapper.BuilderParams

Record Components:

multiFields - sub fields of this mapper

copyTo - copyTo fields of this mapper

sourceKeepMode - mode for storing the field source in synthetic source mode

hasScript - whether a script is defined for the field

onScriptError - the behaviour for when the defined script fails at runtime

Enclosing class:

FieldMapper

protected static record FieldMapper.BuilderParams(FieldMapper.MultiFields multiFields, FieldMapper.CopyTo copyTo, Optional<Mapper.SourceKeepMode> sourceKeepMode, boolean hasScript, OnScriptError onScriptError)
extends Record

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BuilderParams(FieldMapper.MultiFields multiFields, FieldMapper.CopyTo copyTo, Optional<Mapper.SourceKeepMode> sourceKeepMode, boolean hasScript, OnScriptError onScriptError)	Creates an instance of a BuilderParams record class.

Method Summary

Modifier and Type	Method	Description
FieldMapper.CopyTo	copyTo()	Returns the value of the copyTo record component.
static FieldMapper.BuilderParams	empty()
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
boolean	hasScript()	Returns the value of the hasScript record component.
FieldMapper.MultiFields	multiFields()	Returns the value of the multiFields record component.
OnScriptError	onScriptError()	Returns the value of the onScriptError record component.
Optional<Mapper.SourceKeepMode>	sourceKeepMode()	Returns the value of the sourceKeepMode record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

BuilderParams

protected BuilderParams(FieldMapper.MultiFields multiFields,
 FieldMapper.CopyTo copyTo,
 Optional<Mapper.SourceKeepMode> sourceKeepMode,
 boolean hasScript,
 OnScriptError onScriptError)

Creates an instance of a BuilderParams record class.

Parameters:

multiFields - the value for the multiFields record component

copyTo - the value for the copyTo record component

sourceKeepMode - the value for the sourceKeepMode record component

hasScript - the value for the hasScript record component

onScriptError - the value for the onScriptError record component

Method Details

empty

public static FieldMapper.BuilderParams empty()

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

multiFields

public FieldMapper.MultiFields multiFields()

Returns the value of the multiFields record component.

Returns:

the value of the multiFields record component

copyTo

public FieldMapper.CopyTo copyTo()

Returns the value of the copyTo record component.

Returns:

the value of the copyTo record component

sourceKeepMode

public Optional<Mapper.SourceKeepMode> sourceKeepMode()

Returns the value of the sourceKeepMode record component.

Returns:

the value of the sourceKeepMode record component

hasScript

public boolean hasScript()

Returns the value of the hasScript record component.

Returns:

the value of the hasScript record component

onScriptError

public OnScriptError onScriptError()

Returns the value of the onScriptError record component.

Returns:

the value of the onScriptError record component