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

Class HighlightField

java.lang.Object

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

co.elastic.clients.elasticsearch.core.search.HighlightField

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class HighlightField
extends HighlightBase

See Also:

• API specification

Nested Class Summary

Nested Classes

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

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<HighlightField>	_DESERIALIZER	Json deserializer for HighlightField

Method Summary

Modifier and Type	Method	Description
final Analyzer	analyzer()	API name: analyzer
final Integer	fragmentOffset()	API name: fragment_offset
final List<String>	matchedFields()	API name: matched_fields
static HighlightField	of(Function<HighlightField.Builder,ObjectBuilder<HighlightField>> fn)
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupHighlightFieldDeserializer(ObjectDeserializer<HighlightField.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<HighlightField> _DESERIALIZER

Json deserializer for HighlightField

Method Details

of

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

fragmentOffset

@Nullable
public final Integer fragmentOffset()

API name: fragment_offset

matchedFields

public final List<String> matchedFields()

API name: matched_fields

analyzer

@Nullable
public final Analyzer analyzer()

API name: analyzer

serializeInternal

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

Overrides:

serializeInternal in class HighlightBase

setupHighlightFieldDeserializer

protected static void setupHighlightFieldDeserializer(ObjectDeserializer<HighlightField.Builder> op)