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

Class HighlightField.Builder

java.lang.Object

org.opensearch.client.opensearch._global.search.HighlightField.Builder

All Implemented Interfaces:

ObjectBuilder<HighlightField>

Enclosing class:

HighlightField

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

Builder for HighlightField.

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
HighlightField.Builder	addMatchedFields(java.lang.String value)	Add a value to matchedFields(List), creating the list if needed.
HighlightField.Builder	addPostTags(java.lang.String value)	Add a value to postTags(List), creating the list if needed.
HighlightField.Builder	addPreTags(java.lang.String value)	Add a value to preTags(List), creating the list if needed.
HighlightField.Builder	boundaryChars(java.lang.String value)	API name: boundary_chars
HighlightField.Builder	boundaryMaxScan(java.lang.Number value)	API name: boundary_max_scan
HighlightField.Builder	boundaryScanner(jakarta.json.JsonValue value)	API name: boundary_scanner
HighlightField.Builder	boundaryScannerLocale(java.lang.String value)	API name: boundary_scanner_locale
HighlightField	build()	Builds a HighlightField.
HighlightField.Builder	field(java.lang.String value)	API name: field
HighlightField.Builder	forceSource(java.lang.Boolean value)	API name: force_source
HighlightField.Builder	fragmenter(jakarta.json.JsonValue value)	API name: fragmenter
HighlightField.Builder	fragmentOffset(java.lang.Number value)	API name: fragment_offset
HighlightField.Builder	fragmentSize(java.lang.Number value)	API name: fragment_size
HighlightField.Builder	highlightQuery(java.util.function.Function<QueryContainer.Builder,ObjectBuilder<QueryContainer>> fn)	API name: highlight_query
HighlightField.Builder	highlightQuery(QueryContainer value)	API name: highlight_query
HighlightField.Builder	matchedFields(java.lang.String... value)	API name: matched_fields
HighlightField.Builder	matchedFields(java.util.List<java.lang.String> value)	API name: matched_fields
HighlightField.Builder	maxFragmentLength(java.lang.Number value)	API name: max_fragment_length
HighlightField.Builder	noMatchSize(java.lang.Number value)	API name: no_match_size
HighlightField.Builder	numberOfFragments(java.lang.Number value)	API name: number_of_fragments
HighlightField.Builder	order(jakarta.json.JsonValue value)	API name: order
HighlightField.Builder	phraseLimit(java.lang.Number value)	API name: phrase_limit
HighlightField.Builder	postTags(java.lang.String... value)	API name: post_tags
HighlightField.Builder	postTags(java.util.List<java.lang.String> value)	API name: post_tags
HighlightField.Builder	preTags(java.lang.String... value)	API name: pre_tags
HighlightField.Builder	preTags(java.util.List<java.lang.String> value)	API name: pre_tags
HighlightField.Builder	requireFieldMatch(java.lang.Boolean value)	API name: require_field_match
HighlightField.Builder	tagsSchema(jakarta.json.JsonValue value)	API name: tags_schema
HighlightField.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

boundaryChars

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

API name: boundary_chars

boundaryMaxScan

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

API name: boundary_max_scan

boundaryScanner

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

API name: boundary_scanner

boundaryScannerLocale

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

API name: boundary_scanner_locale

field

public HighlightField.Builder field(@Nullable java.lang.String value)

API name: field

forceSource

public HighlightField.Builder forceSource(@Nullable java.lang.Boolean value)

API name: force_source

fragmenter

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

API name: fragmenter

fragmentOffset

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

API name: fragment_offset

fragmentSize

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

API name: fragment_size

highlightQuery

public HighlightField.Builder highlightQuery(@Nullable QueryContainer value)

API name: highlight_query

highlightQuery

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

API name: highlight_query

matchedFields

public HighlightField.Builder matchedFields(@Nullable java.util.List<java.lang.String> value)

API name: matched_fields

matchedFields

public HighlightField.Builder matchedFields(java.lang.String... value)

API name: matched_fields

addMatchedFields

public HighlightField.Builder addMatchedFields(java.lang.String value)

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

maxFragmentLength

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

API name: max_fragment_length

noMatchSize

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

API name: no_match_size

numberOfFragments

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

API name: number_of_fragments

order

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

API name: order

phraseLimit

public HighlightField.Builder phraseLimit(@Nullable java.lang.Number value)

API name: phrase_limit

postTags

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

API name: post_tags

postTags

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

API name: post_tags

addPostTags

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

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

preTags

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

API name: pre_tags

preTags

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

API name: pre_tags

addPreTags

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

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

requireFieldMatch

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

API name: require_field_match

tagsSchema

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

API name: tags_schema

type

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

API name: type

build

public HighlightField build()

Builds a HighlightField.

Specified by:

build in interface ObjectBuilder<HighlightField>

Throws:

java.lang.NullPointerException - if some of the required fields are null.