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

Class HighlightBase.AbstractBuilder<BuilderT extends HighlightBase.AbstractBuilder<BuilderT>>

java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>
co.elastic.clients.elasticsearch.core.search.HighlightBase.AbstractBuilder<BuilderT>
All Implemented Interfaces:
WithJson<BuilderT>
Direct Known Subclasses:
Highlight.Builder, HighlightField.Builder
Enclosing class:
HighlightBase
public abstract static class HighlightBase.AbstractBuilder<BuilderT extends HighlightBase.AbstractBuilder<BuilderT>> extends WithJsonObjectBuilderBase<BuilderT>

  • Constructor Details

    • AbstractBuilder

      public AbstractBuilder()

  • Method Details

    • type

      public final BuilderT type(@Nullable String value)
      API name: type

    • type

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

    • boundaryChars

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

    • boundaryMaxScan

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

    • boundaryScanner

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

    • boundaryScannerLocale

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

    • forceSource

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

    • fragmenter

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

    • fragmentSize

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

    • highlightFilter

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

    • highlightQuery

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

    • highlightQuery

      public final BuilderT highlightQuery(Function<Query.Builder,ObjectBuilder<Query>> fn)
      API name: highlight_query

    • maxFragmentLength

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

    • maxAnalyzedOffset

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

    • noMatchSize

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

    • numberOfFragments

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

    • options

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

      Adds all entries of map to options.

    • options

      public final BuilderT options(String key, JsonData value)
      API name: options

      Adds an entry to options.

    • order

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

    • phraseLimit

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

    • postTags

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

      Adds all elements of list to postTags.

    • postTags

      public final BuilderT postTags(String value, String... values)
      API name: post_tags

      Adds one or more values to postTags.

    • preTags

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

      Adds all elements of list to preTags.

    • preTags

      public final BuilderT preTags(String value, String... values)
      API name: pre_tags

      Adds one or more values to preTags.

    • requireFieldMatch

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

    • tagsSchema

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

    • self

      protected abstract BuilderT self()
      Specified by:
      self in class WithJsonObjectBuilderBase<BuilderT extends HighlightBase.AbstractBuilder<BuilderT>>