Package org.opensearch.client.opensearch.core.search

Class Highlight.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.core.search.Highlight.Builder

All Implemented Interfaces:

ObjectBuilder<Highlight>

Enclosing class:

Highlight

public static class Highlight.Builder
extends ObjectBuilderBase
implements ObjectBuilder<Highlight>

Builder for Highlight.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
Highlight.Builder	boundaryChars(java.lang.String value)	API name: boundary_chars
Highlight.Builder	boundaryMaxScan(java.lang.Integer value)	API name: boundary_max_scan
Highlight.Builder	boundaryScanner(BoundaryScanner value)	API name: boundary_scanner
Highlight.Builder	boundaryScannerLocale(java.lang.String value)	API name: boundary_scanner_locale
Highlight	build()	Builds a Highlight.
Highlight.Builder	encoder(HighlighterEncoder value)	API name: encoder
Highlight.Builder	fields(java.lang.String key, java.util.function.Function<HighlightField.Builder,ObjectBuilder<HighlightField>> fn)	Required - API name: fields
Highlight.Builder	fields(java.lang.String key, HighlightField value)	Required - API name: fields
Highlight.Builder	fields(java.util.Map<java.lang.String,HighlightField> map)	Required - API name: fields
Highlight.Builder	fragmenter(HighlighterFragmenter value)	API name: fragmenter
Highlight.Builder	fragmentOffset(java.lang.Integer value)	API name: fragment_offset
Highlight.Builder	fragmentSize(java.lang.Integer value)	API name: fragment_size
Highlight.Builder	highlightQuery(java.util.function.Function<Query.Builder,ObjectBuilder<Query>> fn)	API name: highlight_query
Highlight.Builder	highlightQuery(Query value)	API name: highlight_query
Highlight.Builder	maxAnalyzerOffset(java.lang.String value)	API name: max_analyzer_offset
Highlight.Builder	maxFragmentLength(java.lang.Integer value)	API name: max_fragment_length
Highlight.Builder	noMatchSize(java.lang.Integer value)	API name: no_match_size
Highlight.Builder	numberOfFragments(java.lang.Integer value)	API name: number_of_fragments
Highlight.Builder	order(HighlighterOrder value)	API name: order
Highlight.Builder	postTags(java.lang.String value, java.lang.String... values)	API name: post_tags
Highlight.Builder	postTags(java.util.List<java.lang.String> list)	API name: post_tags
Highlight.Builder	preTags(java.lang.String value, java.lang.String... values)	API name: pre_tags
Highlight.Builder	preTags(java.util.List<java.lang.String> list)	API name: pre_tags
Highlight.Builder	requireFieldMatch(java.lang.Boolean value)	API name: require_field_match
Highlight.Builder	tagsSchema(HighlighterTagsSchema value)	API name: tags_schema
Highlight.Builder	type(java.util.function.Function<HighlighterType.Builder,ObjectBuilder<HighlighterType>> fn)	API name: type
Highlight.Builder	type(HighlighterType value)	API name: type

Methods inherited from class org.opensearch.client.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

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
                                    HighlighterType value)

API name: type

type

public final Highlight.Builder type(java.util.function.Function<HighlighterType.Builder,ObjectBuilder<HighlighterType>> fn)

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

maxAnalyzerOffset

public final Highlight.Builder maxAnalyzerOffset(@Nullable
                                                 java.lang.String value)

API name: max_analyzer_offset

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.