Package co.elastic.clients.elasticsearch.core.search

Class HighlightBase

java.lang.Object
co.elastic.clients.elasticsearch.core.search.HighlightBase
All Implemented Interfaces:
JsonpSerializable
Direct Known Subclasses:
Highlight, HighlightField
public abstract class HighlightBase extends Object implements JsonpSerializable
See Also:

  • Constructor Details

  • Method Details

    • type

      @Nullable public final HighlighterType type()
      API name: type

    • boundaryChars

      @Nullable public final String boundaryChars()
      API name: boundary_chars

    • boundaryMaxScan

      @Nullable public final Integer boundaryMaxScan()
      API name: boundary_max_scan

    • boundaryScanner

      @Nullable public final BoundaryScanner boundaryScanner()
      API name: boundary_scanner

    • boundaryScannerLocale

      @Nullable public final String boundaryScannerLocale()
      API name: boundary_scanner_locale

    • forceSource

      @Nullable public final Boolean forceSource()
      API name: force_source

    • fragmenter

      @Nullable public final HighlighterFragmenter fragmenter()
      API name: fragmenter

    • fragmentSize

      @Nullable public final Integer fragmentSize()
      API name: fragment_size

    • highlightFilter

      @Nullable public final Boolean highlightFilter()
      API name: highlight_filter

    • highlightQuery

      @Nullable public final Query highlightQuery()
      API name: highlight_query

    • maxFragmentLength

      @Nullable public final Integer maxFragmentLength()
      API name: max_fragment_length

    • maxAnalyzedOffset

      @Nullable public final Integer maxAnalyzedOffset()
      API name: max_analyzed_offset

    • noMatchSize

      @Nullable public final Integer noMatchSize()
      API name: no_match_size

    • numberOfFragments

      @Nullable public final Integer numberOfFragments()
      API name: number_of_fragments

    • options

      public final Map<String,JsonData> options()
      API name: options

    • order

      @Nullable public final HighlighterOrder order()
      API name: order

    • phraseLimit

      @Nullable public final Integer phraseLimit()
      API name: phrase_limit

    • postTags

      public final List<String> postTags()
      API name: post_tags

    • preTags

      public final List<String> preTags()
      API name: pre_tags

    • requireFieldMatch

      @Nullable public final Boolean requireFieldMatch()
      API name: require_field_match

    • tagsSchema

      @Nullable public final HighlighterTagsSchema tagsSchema()
      API name: tags_schema

    • serialize

      public void serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
      Serialize this object to JSON.
      Specified by:
      serialize in interface JsonpSerializable

    • serializeInternal

      protected void serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • setupHighlightBaseDeserializer

      protected static <BuilderT extends HighlightBase.AbstractBuilder<BuilderT>> void setupHighlightBaseDeserializer(ObjectDeserializer<BuilderT> op)