Package org.opensearch.index.mapper

Class FieldAliasMapper

java.lang.Object

org.opensearch.index.mapper.Mapper

org.opensearch.index.mapper.FieldAliasMapper

All Implemented Interfaces:

Iterable<Mapper>, org.opensearch.common.xcontent.ToXContent, org.opensearch.common.xcontent.ToXContentFragment

public final class FieldAliasMapper
extends Mapper

A mapper for field aliases. A field alias has no concrete field mappings of its own, but instead points to another field by its path. Once defined, an alias can be used in place of the concrete field name in search requests.

Opensearch.internal:

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FieldAliasMapper.Builder	The bulider for the field alias field mapper
static class	FieldAliasMapper.Names	Parameter names
static class	FieldAliasMapper.TypeParser	The type parser

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

Mapper.BuilderContext

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

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

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CONTENT_TYPE

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

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
FieldAliasMapper(String simpleName, String name, String path)

Method Summary

Modifier and Type	Method	Description
Iterator<Mapper>	iterator()
Mapper	merge(Mapper mergeWith)	Return the merge of mergeWith into this.
String	name()	Returns the canonical name which uniquely identifies the mapper against other mappers in a type.
String	path()
org.opensearch.common.xcontent.XContentBuilder	toXContent(org.opensearch.common.xcontent.XContentBuilder builder, org.opensearch.common.xcontent.ToXContent.Params params)
String	typeName()	Returns a name representing the type of this mapper.
void	validate(MappingLookup mappers)	Validate any cross-field references made by this mapper

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

hasIndexCreated, simpleName

Methods inherited from class java.lang.Object

clone, 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.common.xcontent.ToXContentFragment

isFragment

Field Details

CONTENT_TYPE

public static final String CONTENT_TYPE

See Also:

• Constant Field Values

Constructor Details

FieldAliasMapper

public FieldAliasMapper(String simpleName,
 String name,
 String path)

Method Details

name

public String name()

Description copied from class: Mapper

Returns the canonical name which uniquely identifies the mapper against other mappers in a type.

Specified by:

name in class Mapper

typeName

public String typeName()

Description copied from class: Mapper

Returns a name representing the type of this mapper.

Specified by:

typeName in class Mapper

path

public String path()

merge

public Mapper merge(Mapper mergeWith)

Description copied from class: Mapper

Return the merge of mergeWith into this. Both this and mergeWith will be left unmodified.

Specified by:

merge in class Mapper

iterator

public Iterator<Mapper> iterator()

toXContent

public org.opensearch.common.xcontent.XContentBuilder toXContent(org.opensearch.common.xcontent.XContentBuilder builder,
 org.opensearch.common.xcontent.ToXContent.Params params)
                                                          throws IOException

Throws:

IOException

validate

public void validate(MappingLookup mappers)

Description copied from class: Mapper

Validate any cross-field references made by this mapper

Specified by:

validate in class Mapper

Parameters:

mappers - a MappingLookup that can produce references to other mappers