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

Class Highlight

java.lang.Object

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

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class Highlight
extends java.lang.Object
implements JsonpSerializable

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Highlight.Builder	Builder for Highlight.

Field Summary

Fields

Modifier and Type	Field	Description
static JsonpDeserializer<Highlight>	_DESERIALIZER	Json deserializer for Highlight

Method Summary

Modifier and Type	Method	Description
java.lang.String	boundaryChars()	API name: boundary_chars
java.lang.Integer	boundaryMaxScan()	API name: boundary_max_scan
BoundaryScanner	boundaryScanner()	API name: boundary_scanner
java.lang.String	boundaryScannerLocale()	API name: boundary_scanner_locale
HighlighterEncoder	encoder()	API name: encoder
java.util.Map<java.lang.String,HighlightField>	fields()	Required - API name: fields
HighlighterFragmenter	fragmenter()	API name: fragmenter
java.lang.Integer	fragmentOffset()	API name: fragment_offset
java.lang.Integer	fragmentSize()	API name: fragment_size
Query	highlightQuery()	API name: highlight_query
java.lang.String	maxAnalyzerOffset()	API name: max_analyzer_offset
java.lang.Integer	maxFragmentLength()	API name: max_fragment_length
java.lang.Integer	noMatchSize()	API name: no_match_size
java.lang.Integer	numberOfFragments()	API name: number_of_fragments
static Highlight	of(java.util.function.Function<Highlight.Builder,ObjectBuilder<Highlight>> fn)
HighlighterOrder	order()	API name: order
java.util.List<java.lang.String>	postTags()	API name: post_tags
java.util.List<java.lang.String>	preTags()	API name: pre_tags
java.lang.Boolean	requireFieldMatch()	API name: require_field_match
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this object to JSON.
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupHighlightDeserializer(ObjectDeserializer<Highlight.Builder> op)
HighlighterTagsSchema	tagsSchema()	API name: tags_schema
HighlighterType	type()	API name: type

Methods inherited from class java.lang.Object

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

Field Detail

_DESERIALIZER

public static final JsonpDeserializer<Highlight> _DESERIALIZER

Json deserializer for Highlight

Method Detail

of

public static Highlight of(java.util.function.Function<Highlight.Builder,ObjectBuilder<Highlight>> fn)

fields

public final java.util.Map<java.lang.String,HighlightField> fields()

Required - API name: fields

type

@Nullable
public final HighlighterType type()

API name: type

boundaryChars

@Nullable
public final java.lang.String boundaryChars()

API name: boundary_chars

boundaryMaxScan

@Nullable
public final java.lang.Integer boundaryMaxScan()

API name: boundary_max_scan

boundaryScanner

@Nullable
public final BoundaryScanner boundaryScanner()

API name: boundary_scanner

boundaryScannerLocale

@Nullable
public final java.lang.String boundaryScannerLocale()

API name: boundary_scanner_locale

encoder

@Nullable
public final HighlighterEncoder encoder()

API name: encoder

fragmenter

@Nullable
public final HighlighterFragmenter fragmenter()

API name: fragmenter

fragmentOffset

@Nullable
public final java.lang.Integer fragmentOffset()

API name: fragment_offset

fragmentSize

@Nullable
public final java.lang.Integer fragmentSize()

API name: fragment_size

maxFragmentLength

@Nullable
public final java.lang.Integer maxFragmentLength()

API name: max_fragment_length

noMatchSize

@Nullable
public final java.lang.Integer noMatchSize()

API name: no_match_size

numberOfFragments

@Nullable
public final java.lang.Integer numberOfFragments()

API name: number_of_fragments

order

@Nullable
public final HighlighterOrder order()

API name: order

postTags

public final java.util.List<java.lang.String> postTags()

API name: post_tags

preTags

public final java.util.List<java.lang.String> preTags()

API name: pre_tags

requireFieldMatch

@Nullable
public final java.lang.Boolean requireFieldMatch()

API name: require_field_match

tagsSchema

@Nullable
public final HighlighterTagsSchema tagsSchema()

API name: tags_schema

highlightQuery

@Nullable
public final Query highlightQuery()

API name: highlight_query

maxAnalyzerOffset

@Nullable
public final java.lang.String maxAnalyzerOffset()

API name: max_analyzer_offset

serialize

public void serialize(jakarta.json.stream.JsonGenerator generator,
                      JsonpMapper mapper)

Serialize this object to JSON.

Specified by:

serialize in interface JsonpSerializable

serializeInternal

protected void serializeInternal(jakarta.json.stream.JsonGenerator generator,
                                 JsonpMapper mapper)

setupHighlightDeserializer

protected static void setupHighlightDeserializer(ObjectDeserializer<Highlight.Builder> op)