Record Class IgnoredFieldsSpec

java.lang.Object
java.lang.Record
org.elasticsearch.index.mapper.IgnoredFieldsSpec

public record IgnoredFieldsSpec(Set<String> requiredIgnoredFields, IgnoredSourceFieldMapper.IgnoredSourceFormat format) extends Record
Defines which fields need to be loaded from _ignored_source during a fetch.
  • Field Details

  • Constructor Details

    • IgnoredFieldsSpec

      public IgnoredFieldsSpec(Set<String> requiredIgnoredFields, IgnoredSourceFieldMapper.IgnoredSourceFormat format)
      Creates an instance of a IgnoredFieldsSpec record class.
      Parameters:
      requiredIgnoredFields - the value for the requiredIgnoredFields record component
      format - the value for the format record component
  • Method Details

    • noRequirements

      public boolean noRequirements()
    • merge

      public IgnoredFieldsSpec merge(IgnoredFieldsSpec other)
    • requiredStoredFields

      public Set<String> requiredStoredFields()
      Get the set of stored fields required to load the specified fields from _ignored_source.
    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object
    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object
    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.
    • requiredIgnoredFields

      public Set<String> requiredIgnoredFields()
      Returns the value of the requiredIgnoredFields record component.
      Returns:
      the value of the requiredIgnoredFields record component
    • format

      Returns the value of the format record component.
      Returns:
      the value of the format record component