Package org.opensearch.client.opensearch._global.search

Class HighlightField

java.lang.Object
org.opensearch.client.opensearch._global.search.HighlightField
All Implemented Interfaces:
ToJsonp
public final class HighlightField
extends java.lang.Object
implements ToJsonp

  • Field Details

  • Constructor Details

  • Method Details

    • boundaryChars

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

    • boundaryMaxScan

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

    • boundaryScanner

      @Nullable public jakarta.json.JsonValue boundaryScanner()
      API name: boundary_scanner

    • boundaryScannerLocale

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

    • field

      @Nullable public java.lang.String field()
      API name: field

    • forceSource

      @Nullable public java.lang.Boolean forceSource()
      API name: force_source

    • fragmenter

      @Nullable public jakarta.json.JsonValue fragmenter()
      API name: fragmenter

    • fragmentOffset

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

    • fragmentSize

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

    • highlightQuery

      @Nullable public QueryContainer highlightQuery()
      API name: highlight_query

    • matchedFields

      @Nullable public java.util.List<java.lang.String> matchedFields()
      API name: matched_fields

    • maxFragmentLength

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

    • noMatchSize

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

    • numberOfFragments

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

    • order

      @Nullable public jakarta.json.JsonValue order()
      API name: order

    • phraseLimit

      @Nullable public java.lang.Number phraseLimit()
      API name: phrase_limit

    • postTags

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

    • preTags

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

    • requireFieldMatch

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

    • tagsSchema

      @Nullable public jakarta.json.JsonValue tagsSchema()
      API name: tags_schema

    • type

      @Nullable public jakarta.json.JsonValue type()
      API name: type

    • toJsonp

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

    • toJsonpInternal

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

    • setupHighlightFieldDeserializer

      protected static void setupHighlightFieldDeserializer​(DelegatingDeserializer<HighlightField.Builder> op)