Package org.opensearch.index.mapper

Class FieldNamesFieldMapper

java.lang.Object

org.opensearch.index.mapper.Mapper

org.opensearch.index.mapper.FieldMapper

org.opensearch.index.mapper.ParametrizedFieldMapper

org.opensearch.index.mapper.MetadataFieldMapper

org.opensearch.index.mapper.FieldNamesFieldMapper

All Implemented Interfaces:

Cloneable, Iterable<Mapper>, org.opensearch.core.xcontent.ToXContent, org.opensearch.core.xcontent.ToXContentFragment

public class FieldNamesFieldMapper
extends MetadataFieldMapper

A mapper that indexes the field names of a document under _field_names. This mapper is typically useful in order to have fast exists and missing queries/filters.

Opensearch.internal:

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FieldNamesFieldMapper.Defaults	Parameter defaults
static final class	FieldNamesFieldMapper.FieldNamesFieldType	Field type for FieldNames field mapper

Nested classes/interfaces inherited from class org.opensearch.index.mapper.MetadataFieldMapper

MetadataFieldMapper.ConfigurableTypeParser, MetadataFieldMapper.FixedTypeParser, MetadataFieldMapper.TypeParser

Nested classes/interfaces inherited from class org.opensearch.index.mapper.ParametrizedFieldMapper

ParametrizedFieldMapper.Parameter<T>, ParametrizedFieldMapper.Serializer<T>, ParametrizedFieldMapper.SerializerCheck<T>

Nested classes/interfaces inherited from class org.opensearch.index.mapper.FieldMapper

FieldMapper.CopyTo, FieldMapper.MultiFields

Nested classes/interfaces inherited from class org.opensearch.index.mapper.Mapper

Mapper.BuilderContext

Nested classes/interfaces inherited from interface org.opensearch.core.xcontent.ToXContent

org.opensearch.core.xcontent.ToXContent.DelegatingMapParams, org.opensearch.core.xcontent.ToXContent.MapParams, org.opensearch.core.xcontent.ToXContent.Params

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CONTENT_TYPE
static final String	ENABLED_DEPRECATION_MESSAGE
static final String	NAME
static final MetadataFieldMapper.TypeParser	PARSER

Fields inherited from class org.opensearch.index.mapper.FieldMapper

COERCE_SETTING, copyTo, fieldType, IGNORE_MALFORMED_SETTING, mappedFieldType, multiFields

Fields inherited from interface org.opensearch.core.xcontent.ToXContent

EMPTY_PARAMS

Method Summary

Modifier and Type	Method	Description
protected String	contentType()
FieldNamesFieldMapper.FieldNamesFieldType	fieldType()
ParametrizedFieldMapper.Builder	getMergeBuilder()	Returns a ParametrizedFieldMapper.Builder to be used for merging and serialization

Methods inherited from class org.opensearch.index.mapper.MetadataFieldMapper

parseCreateField, postParse, preParse, toXContent, updateableBoolParam

Methods inherited from class org.opensearch.index.mapper.ParametrizedFieldMapper

doXContentBody, merge, mergeOptions

Methods inherited from class org.opensearch.index.mapper.FieldMapper

clone, copyTo, createFieldNamesField, docValuesByDefault, doValidate, doXContentAnalyzers, indexedByDefault, indexOptionToString, iterator, multiFields, name, parse, parsesArrayValue, storedByDefault, typeName, validate

Methods inherited from class org.opensearch.index.mapper.Mapper

hasIndexCreated, simpleName

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface org.opensearch.core.xcontent.ToXContentFragment

isFragment

Field Details

NAME

public static final String NAME

See Also:

• Constant Field Values

CONTENT_TYPE

public static final String CONTENT_TYPE

See Also:

• Constant Field Values

ENABLED_DEPRECATION_MESSAGE

public static final String ENABLED_DEPRECATION_MESSAGE

See Also:

• Constant Field Values

PARSER

public static final MetadataFieldMapper.TypeParser PARSER

Method Details

getMergeBuilder

public ParametrizedFieldMapper.Builder getMergeBuilder()

Description copied from class: ParametrizedFieldMapper

Returns a ParametrizedFieldMapper.Builder to be used for merging and serialization

Implement as follows: return new MyBuilder(simpleName()).init(this);

Overrides:

getMergeBuilder in class MetadataFieldMapper

fieldType

public FieldNamesFieldMapper.FieldNamesFieldType fieldType()

Overrides:

fieldType in class FieldMapper

contentType

protected String contentType()

Specified by:

contentType in class FieldMapper