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

Class Highlight.Builder

java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<Highlight.Builder>
co.elastic.clients.elasticsearch.core.search.Highlight.Builder
All Implemented Interfaces:
WithJson<Highlight.Builder>, ObjectBuilder<Highlight>
Enclosing class:
Highlight
public static class Highlight.Builder
extends WithJsonObjectBuilderBase<Highlight.Builder>
implements ObjectBuilder<Highlight>
Builder for Highlight.

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • fields

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

      Adds all entries of map to fields.

    • fields

      public final Highlight.Builder fields​(java.lang.String key, HighlightField value)
      Required - API name: fields

      Adds an entry to fields.

    • fields

      public final Highlight.Builder fields​(java.lang.String key, java.util.function.Function<HighlightField.Builder,​ObjectBuilder<HighlightField>> fn)
      Required - API name: fields

      Adds an entry to fields using a builder lambda.

    • type

      public final Highlight.Builder type​(@Nullable java.lang.String value)
      API name: type

    • type

      public final Highlight.Builder type​(@Nullable HighlighterType value)
      API name: type

    • boundaryChars

      public final Highlight.Builder boundaryChars​(@Nullable java.lang.String value)
      API name: boundary_chars

    • boundaryMaxScan

      public final Highlight.Builder boundaryMaxScan​(@Nullable java.lang.Integer value)
      API name: boundary_max_scan

    • boundaryScanner

      public final Highlight.Builder boundaryScanner​(@Nullable BoundaryScanner value)
      API name: boundary_scanner

    • boundaryScannerLocale

      public final Highlight.Builder boundaryScannerLocale​(@Nullable java.lang.String value)
      API name: boundary_scanner_locale

    • encoder

      public final Highlight.Builder encoder​(@Nullable HighlighterEncoder value)
      API name: encoder

    • fragmenter

      public final Highlight.Builder fragmenter​(@Nullable HighlighterFragmenter value)
      API name: fragmenter

    • fragmentOffset

      public final Highlight.Builder fragmentOffset​(@Nullable java.lang.Integer value)
      API name: fragment_offset

    • fragmentSize

      public final Highlight.Builder fragmentSize​(@Nullable java.lang.Integer value)
      API name: fragment_size

    • maxFragmentLength

      public final Highlight.Builder maxFragmentLength​(@Nullable java.lang.Integer value)
      API name: max_fragment_length

    • noMatchSize

      public final Highlight.Builder noMatchSize​(@Nullable java.lang.Integer value)
      API name: no_match_size

    • numberOfFragments

      public final Highlight.Builder numberOfFragments​(@Nullable java.lang.Integer value)
      API name: number_of_fragments

    • order

      public final Highlight.Builder order​(@Nullable HighlighterOrder value)
      API name: order

    • postTags

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

      Adds all elements of list to postTags.

    • postTags

      public final Highlight.Builder postTags​(java.lang.String value, java.lang.String... values)
      API name: post_tags

      Adds one or more values to postTags.

    • preTags

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

      Adds all elements of list to preTags.

    • preTags

      public final Highlight.Builder preTags​(java.lang.String value, java.lang.String... values)
      API name: pre_tags

      Adds one or more values to preTags.

    • requireFieldMatch

      public final Highlight.Builder requireFieldMatch​(@Nullable java.lang.Boolean value)
      API name: require_field_match

    • tagsSchema

      public final Highlight.Builder tagsSchema​(@Nullable HighlighterTagsSchema value)
      API name: tags_schema

    • highlightQuery

      public final Highlight.Builder highlightQuery​(@Nullable Query value)
      API name: highlight_query

    • highlightQuery

      public final Highlight.Builder highlightQuery​(java.util.function.Function<Query.Builder,​ObjectBuilder<Query>> fn)
      API name: highlight_query

    • maxAnalyzedOffset

      public final Highlight.Builder maxAnalyzedOffset​(@Nullable java.lang.String value)
      API name: max_analyzed_offset

    • self

      protected Highlight.Builder self()
      Specified by:
      self in class WithJsonObjectBuilderBase<Highlight.Builder>

    • build

      public Highlight build()
      Builds a Highlight.
      Specified by:
      build in interface ObjectBuilder<Highlight>
      Throws:
      java.lang.NullPointerException - if some of the required fields are null.