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

Class HighlightField

java.lang.Object

org.opensearch.client.opensearch.core.search.HighlightField

All Implemented Interfaces:

JsonpSerializable

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

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

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
java.lang.String	field()	API name: field
java.lang.Boolean	forceSource()	API name: force_source
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.util.List<java.lang.String>	matchedFields()	API name: matched_fields
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 HighlightField	of(java.util.function.Function<HighlightField.Builder,ObjectBuilder<HighlightField>> fn)
HighlighterOrder	order()	API name: order
java.lang.Integer	phraseLimit()	API name: phrase_limit
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	setupHighlightFieldDeserializer(ObjectDeserializer<HighlightField.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<HighlightField> _DESERIALIZER

Json deserializer for HighlightField

Method Detail

of

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

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

field

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

API name: field

forceSource

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

API name: force_source

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

highlightQuery

@Nullable
public final Query highlightQuery()

API name: highlight_query

matchedFields

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

API name: matched_fields

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

phraseLimit

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

API name: phrase_limit

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

type

@Nullable
public final HighlighterType type()

API name: type

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)

setupHighlightFieldDeserializer

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