Module org.elasticsearch.server

Package org.elasticsearch.index.mapper

Class FieldMapper.DocValuesParameter

java.lang.Object

org.elasticsearch.index.mapper.FieldMapper.Parameter<FieldMapper.DocValuesParameter.Values>

org.elasticsearch.index.mapper.FieldMapper.DocValuesParameter

All Implemented Interfaces:

Supplier<FieldMapper.DocValuesParameter.Values>

Enclosing class:

FieldMapper

public static final class FieldMapper.DocValuesParameter
extends FieldMapper.Parameter<FieldMapper.DocValuesParameter.Values>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	FieldMapper.DocValuesParameter.Values

Field Summary

Fields

Modifier and Type	Field	Description
final FieldMapper.Parameter<FieldMapper.DocValuesParameter.Values.Cardinality>	cardinalityParameter
static FeatureFlag	EXTENDED_DOC_VALUES_PARAMS_FF
static final String	PARAMETER_NAME

Fields inherited from class org.elasticsearch.index.mapper.FieldMapper.Parameter

name

Constructor Summary

Constructors

Constructor	Description
DocValuesParameter(FieldMapper.DocValuesParameter.Values defaultValue, Function<FieldMapper,FieldMapper.DocValuesParameter.Values> initializer)

Method Summary

Modifier and Type	Method	Description
void	parse(String field, MappingParserContext context, Object value)	Parse the field value from an Object
void	setValue(FieldMapper.DocValuesParameter.Values value)	Sets the current value of the parameter
protected void	toXContent(XContentBuilder builder, boolean includeDefaults)

Methods inherited from class org.elasticsearch.index.mapper.FieldMapper.Parameter

acceptsNull, addDeprecatedName, addValidator, alwaysSerialize, analyzerParam, analyzerParam, boolParam, boolParam, canAcceptNull, deprecated, docValuesParam, enumParam, enumParam, explicitBoolParam, get, getDefaultValue, getValue, ignoreAboveParam, indexParam, indexParam, indexParam, intParam, isConfigured, isSet, metaParam, neverSerialize, normsParam, normsParam, onScriptErrorParam, precludesParameters, requiresParameter, restrictedEnumParam, restrictedEnumParam, scriptParam, setMergeValidator, setSerializerCheck, storeParam, storeParam, stringArrayParam, stringParam, stringParam, useTimeSeriesDocValuesSkippers

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

PARAMETER_NAME

public static final String PARAMETER_NAME

See Also:

• Constant Field Values

EXTENDED_DOC_VALUES_PARAMS_FF

public static FeatureFlag EXTENDED_DOC_VALUES_PARAMS_FF

cardinalityParameter

public final FieldMapper.Parameter<FieldMapper.DocValuesParameter.Values.Cardinality> cardinalityParameter

Constructor Details

DocValuesParameter

public DocValuesParameter(FieldMapper.DocValuesParameter.Values defaultValue,
 Function<FieldMapper,FieldMapper.DocValuesParameter.Values> initializer)

Method Details

parse

public void parse(String field,
 MappingParserContext context,
 Object value)

Description copied from class: FieldMapper.Parameter

Parse the field value from an Object

Overrides:

parse in class FieldMapper.Parameter<FieldMapper.DocValuesParameter.Values>

Parameters:

field - the field name

context - the parser context

value - the object

setValue

public void setValue(FieldMapper.DocValuesParameter.Values value)

Description copied from class: FieldMapper.Parameter

Sets the current value of the parameter

Overrides:

setValue in class FieldMapper.Parameter<FieldMapper.DocValuesParameter.Values>

toXContent

protected void toXContent(XContentBuilder builder,
 boolean includeDefaults)
                   throws IOException

Overrides:

toXContent in class FieldMapper.Parameter<FieldMapper.DocValuesParameter.Values>

Throws:

IOException