Package org.opensearch.index.mapper

Class IdFieldMapper

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.IdFieldMapper

All Implemented Interfaces:

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

@PublicApi(since="1.0.0")
public class IdFieldMapper
extends MetadataFieldMapper

A mapper for the _id field. It does nothing since _id is neither indexed nor stored, but we need to keep it so that its FieldType can be used to generate queries.

Opensearch.api:

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	IdFieldMapper.Defaults	Default parameters

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

MetadataFieldMapper.Builder, 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	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()
void	preParse(ParseContext context)	Called before FieldMapper.parse(ParseContext) on the RootObjectMapper.

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

getMergeBuilder, parseCreateField, postParse, 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, fieldType, 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

PARSER

public static final MetadataFieldMapper.TypeParser PARSER

Method Details

preParse

public void preParse(ParseContext context)

Description copied from class: MetadataFieldMapper

Called before FieldMapper.parse(ParseContext) on the RootObjectMapper.

Overrides:

preParse in class MetadataFieldMapper

contentType

protected String contentType()

Specified by:

contentType in class FieldMapper