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

Class Highlight

java.lang.Object
co.elastic.clients.elasticsearch.core.search.Highlight
All Implemented Interfaces:
JsonpSerializable
@JsonpDeserializable
public class Highlight
extends java.lang.Object
implements JsonpSerializable
See Also:
API specification

  • Field Details

  • Method Details

    • of

      public static Highlight of​(java.util.function.Function<Highlight.Builder,​ObjectBuilder<Highlight>> fn)

    • fields

      public final java.util.Map<java.lang.String,​HighlightField> fields()
      Required - API name: fields

    • type

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

    • boundaryChars

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

    • boundaryMaxScan

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

    • boundaryScanner

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

    • boundaryScannerLocale

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

    • encoder

      @Nullable public final HighlighterEncoder encoder()
      API name: encoder

    • fragmenter

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

    • fragmentOffset

      @Nullable public final java.lang.Integer fragmentOffset()
      API name: fragment_offset

    • fragmentSize

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

    • maxFragmentLength

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

    • noMatchSize

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

    • numberOfFragments

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

    • order

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

    • postTags

      public final java.util.List<java.lang.String> postTags()
      API name: post_tags

    • preTags

      public final java.util.List<java.lang.String> preTags()
      API name: pre_tags

    • requireFieldMatch

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

    • tagsSchema

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

    • highlightQuery

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

    • maxAnalyzedOffset

      @Nullable public final java.lang.String maxAnalyzedOffset()
      API name: max_analyzed_offset

    • 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)

    • setupHighlightDeserializer

      protected static void setupHighlightDeserializer​(ObjectDeserializer<Highlight.Builder> op)