java.lang.Object
org.elasticsearch.index.mapper.Mapper
org.elasticsearch.index.mapper.FieldAliasMapper
- All Implemented Interfaces:
Iterable<Mapper>,ToXContent,ToXContentFragment
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.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classstatic classstatic classNested classes/interfaces inherited from class org.elasticsearch.index.mapper.Mapper
Mapper.SourceKeepModeNested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent
ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params -
Field Summary
FieldsFields inherited from class org.elasticsearch.index.mapper.Mapper
SYNTHETIC_SOURCE_KEEP_FEATURE, SYNTHETIC_SOURCE_KEEP_INDEX_SETTING, SYNTHETIC_SOURCE_KEEP_PARAMFields inherited from interface org.elasticsearch.xcontent.ToXContent
EMPTY, EMPTY_PARAMS -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionfullPath()Returns the canonical name which uniquely identifies the mapper against other mappers in a type.intThe total number of fields as defined in the mapping.iterator()merge(Mapper mergeWith, MapperMergeContext mapperMergeContext) Return the merge ofmergeWithinto this.toXContent(XContentBuilder builder, ToXContent.Params params) typeName()Returns a name representing the type of this mapper.voidvalidate(MappingLookup mappers) Validate any cross-field references made by this mapperMethods inherited from class org.elasticsearch.index.mapper.Mapper
freezeAndDeduplicateFieldType, internFieldName, leafName, toStringMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface java.lang.Iterable
forEach, spliteratorMethods inherited from interface org.elasticsearch.xcontent.ToXContentFragment
isFragment
-
Field Details
-
CONTENT_TYPE
- See Also:
-
-
Constructor Details
-
FieldAliasMapper
-
-
Method Details
-
fullPath
Description copied from class:MapperReturns the canonical name which uniquely identifies the mapper against other mappers in a type. -
typeName
Description copied from class:MapperReturns a name representing the type of this mapper. -
targetPath
-
merge
Description copied from class:MapperReturn the merge ofmergeWithinto this. BoththisandmergeWithwill be left unmodified. -
iterator
-
toXContent
public XContentBuilder toXContent(XContentBuilder builder, ToXContent.Params params) throws IOException - Throws:
IOException
-
validate
Description copied from class:MapperValidate any cross-field references made by this mapper- Specified by:
validatein classMapper- Parameters:
mappers- aMappingLookupthat can produce references to other mappers
-
getTotalFieldsCount
public int getTotalFieldsCount()Description copied from class:MapperThe total number of fields as defined in the mapping. Defines how this mapper counts towardsMapperService.INDEX_MAPPING_TOTAL_FIELDS_LIMIT_SETTING.- Specified by:
getTotalFieldsCountin classMapper
-