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

Class Highlight.Builder

java.lang.Object

org.opensearch.client.opensearch._global.search.Highlight.Builder

All Implemented Interfaces:

ObjectBuilder<Highlight>

Enclosing class:

Highlight

public static class Highlight.Builder
extends java.lang.Object
implements ObjectBuilder<Highlight>

Builder for Highlight.

Nested Class Summary

Nested classes/interfaces inherited from interface org.opensearch.client.util.ObjectBuilder

ObjectBuilder.Constant<V>

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
Highlight.Builder	addPostTags(java.lang.String value)	Add a value to postTags(List), creating the list if needed.
Highlight.Builder	addPreTags(java.lang.String value)	Add a value to preTags(List), creating the list if needed.
Highlight.Builder	boundaryChars(java.lang.String value)	API name: boundary_chars
Highlight.Builder	boundaryMaxScan(java.lang.Number value)	API name: boundary_max_scan
Highlight.Builder	boundaryScanner(jakarta.json.JsonValue 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(jakarta.json.JsonValue value)	API name: encoder
Highlight.Builder	fields(java.lang.String key, java.util.function.Function<HighlightField.Builder,ObjectBuilder<HighlightField>> fn)	Set fields(Map) to a singleton map.
Highlight.Builder	fields(java.util.Map<java.lang.String,HighlightField> value)	API name: fields
Highlight.Builder	fragmenter(jakarta.json.JsonValue value)	API name: fragmenter
Highlight.Builder	fragmentOffset(java.lang.Number value)	API name: fragment_offset
Highlight.Builder	fragmentSize(java.lang.Number value)	API name: fragment_size
Highlight.Builder	highlightQuery(java.util.function.Function<QueryContainer.Builder,ObjectBuilder<QueryContainer>> fn)	API name: highlight_query
Highlight.Builder	highlightQuery(QueryContainer value)	API name: highlight_query
Highlight.Builder	maxAnalyzedOffset(jakarta.json.JsonValue value)	API name: max_analyzed_offset
Highlight.Builder	maxFragmentLength(java.lang.Number value)	API name: max_fragment_length
Highlight.Builder	noMatchSize(java.lang.Number value)	API name: no_match_size
Highlight.Builder	numberOfFragments(java.lang.Number value)	API name: number_of_fragments
Highlight.Builder	order(jakarta.json.JsonValue value)	API name: order
Highlight.Builder	postTags(java.lang.String... value)	API name: post_tags
Highlight.Builder	postTags(java.util.List<java.lang.String> value)	API name: post_tags
Highlight.Builder	preTags(java.lang.String... value)	API name: pre_tags
Highlight.Builder	preTags(java.util.List<java.lang.String> value)	API name: pre_tags
Highlight.Builder	putFields(java.lang.String key, java.util.function.Function<HighlightField.Builder,ObjectBuilder<HighlightField>> fn)	Add a key/value to fields(Map), creating the map if needed.
Highlight.Builder	putFields(java.lang.String key, HighlightField value)	Add a key/value to fields(Map), creating the map if needed.
Highlight.Builder	requireFieldMatch(java.lang.Boolean value)	API name: require_field_match
Highlight.Builder	tagsSchema(jakarta.json.JsonValue value)	API name: tags_schema
Highlight.Builder	type(jakarta.json.JsonValue value)	API name: type

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

fields

public Highlight.Builder fields(java.util.Map<java.lang.String,HighlightField> value)

API name: fields

putFields

public Highlight.Builder putFields(java.lang.String key, HighlightField value)

Add a key/value to fields(Map), creating the map if needed.

fields

public Highlight.Builder fields(java.lang.String key, java.util.function.Function<HighlightField.Builder,ObjectBuilder<HighlightField>> fn)

Set fields(Map) to a singleton map.

putFields

public Highlight.Builder putFields(java.lang.String key, java.util.function.Function<HighlightField.Builder,ObjectBuilder<HighlightField>> fn)

Add a key/value to fields(Map), creating the map if needed.

type

public Highlight.Builder type(@Nullable jakarta.json.JsonValue value)

API name: type

boundaryChars

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

API name: boundary_chars

boundaryMaxScan

public Highlight.Builder boundaryMaxScan(@Nullable java.lang.Number value)

API name: boundary_max_scan

boundaryScanner

public Highlight.Builder boundaryScanner(@Nullable jakarta.json.JsonValue value)

API name: boundary_scanner

boundaryScannerLocale

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

API name: boundary_scanner_locale

encoder

public Highlight.Builder encoder(@Nullable jakarta.json.JsonValue value)

API name: encoder

fragmenter

public Highlight.Builder fragmenter(@Nullable jakarta.json.JsonValue value)

API name: fragmenter

fragmentOffset

public Highlight.Builder fragmentOffset(@Nullable java.lang.Number value)

API name: fragment_offset

fragmentSize

public Highlight.Builder fragmentSize(@Nullable java.lang.Number value)

API name: fragment_size

maxFragmentLength

public Highlight.Builder maxFragmentLength(@Nullable java.lang.Number value)

API name: max_fragment_length

noMatchSize

public Highlight.Builder noMatchSize(@Nullable java.lang.Number value)

API name: no_match_size

numberOfFragments

public Highlight.Builder numberOfFragments(@Nullable java.lang.Number value)

API name: number_of_fragments

order

public Highlight.Builder order(@Nullable jakarta.json.JsonValue value)

API name: order

postTags

public Highlight.Builder postTags(@Nullable java.util.List<java.lang.String> value)

API name: post_tags

postTags

public Highlight.Builder postTags(java.lang.String... value)

API name: post_tags

addPostTags

public Highlight.Builder addPostTags(java.lang.String value)

Add a value to postTags(List), creating the list if needed.

preTags

public Highlight.Builder preTags(@Nullable java.util.List<java.lang.String> value)

API name: pre_tags

preTags

public Highlight.Builder preTags(java.lang.String... value)

API name: pre_tags

addPreTags

public Highlight.Builder addPreTags(java.lang.String value)

Add a value to preTags(List), creating the list if needed.

requireFieldMatch

public Highlight.Builder requireFieldMatch(@Nullable java.lang.Boolean value)

API name: require_field_match

tagsSchema

public Highlight.Builder tagsSchema(@Nullable jakarta.json.JsonValue value)

API name: tags_schema

highlightQuery

public Highlight.Builder highlightQuery(@Nullable QueryContainer value)

API name: highlight_query

highlightQuery

public Highlight.Builder highlightQuery(java.util.function.Function<QueryContainer.Builder,ObjectBuilder<QueryContainer>> fn)

API name: highlight_query

maxAnalyzedOffset

public Highlight.Builder maxAnalyzedOffset(@Nullable jakarta.json.JsonValue value)

API name: max_analyzed_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.