Module org.elasticsearch.server
Package org.elasticsearch.index.mapper

Interface PassThroughFieldSource

All Known Implementing Classes:
FlattenedFieldMapper, PassThroughObjectMapper
public sealed interface PassThroughFieldSource permits PassThroughObjectMapper, FlattenedFieldMapper
Implemented by mapper types that expose sub-fields as root-level aliases (passthrough behavior). Both PassThroughObjectMapper and passthrough-enabled FlattenedFieldMapper implement this interface, allowing FieldTypeLookup and MappingLookup to resolve passthrough aliases in a unified, priority-based way.

  • Method Details

    • priority

      int priority()
      The non-negative priority used to resolve conflicts when multiple passthrough sources expose sub-fields with the same leaf name at the root level. Higher priority wins.

    • fullPath

      String fullPath()
      The fully-qualified path of this field/mapper in the index mapping.

    • passThroughSubFields

      Collection<FieldMapper> passThroughSubFields()
      The set of sub-field mappers whose Mapper.leafName() should be registered as root-level aliases. Returns an empty collection when passthrough is disabled or there are no eligible sub-fields.

    • resolveConflictingPriorities

      static Map<String,FieldMapper> resolveConflictingPriorities(Collection<PassThroughFieldSource> passThroughSources)