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

Class Highlight

java.lang.Object

co.elastic.clients.elasticsearch.core.search.HighlightBase

co.elastic.clients.elasticsearch.core.search.Highlight

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class Highlight
extends HighlightBase

See Also:

• API specification

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch.core.search.HighlightBase

HighlightBase.AbstractBuilder<BuilderT extends HighlightBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
final HighlighterEncoder	encoder()	API name: encoder
final Map<String,HighlightField>	fields()	Required - API name: fields
static Highlight	of(Function<Highlight.Builder,ObjectBuilder<Highlight>> fn)
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupHighlightDeserializer(ObjectDeserializer<Highlight.Builder> op)

Methods inherited from class co.elastic.clients.elasticsearch.core.search.HighlightBase

boundaryChars, boundaryMaxScan, boundaryScanner, boundaryScannerLocale, forceSource, fragmenter, fragmentSize, highlightFilter, highlightQuery, maxAnalyzedOffset, maxFragmentLength, noMatchSize, numberOfFragments, options, order, phraseLimit, postTags, preTags, requireFieldMatch, serialize, setupHighlightBaseDeserializer, tagsSchema, toString, type

Methods inherited from class java.lang.Object

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

Field Details

_DESERIALIZER

public static final JsonpDeserializer<Highlight> _DESERIALIZER

Json deserializer for Highlight

Method Details

of

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

encoder

@Nullable
public final HighlighterEncoder encoder()

API name: encoder

fields

public final Map<String,HighlightField> fields()

Required - API name: fields

serializeInternal

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

Overrides:

serializeInternal in class HighlightBase

setupHighlightDeserializer

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