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

Class HighlightField

java.lang.Object

org.opensearch.client.opensearch.core.search.HighlightBase

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

All Implemented Interfaces:

JsonpSerializable, PlainJsonSerializable, ToCopyableBuilder<HighlightField.Builder,HighlightField>

@JsonpDeserializable
@Generated("org.opensearch.client.codegen.CodeGenerator")
public class HighlightField
extends HighlightBase
implements ToCopyableBuilder<HighlightField.Builder,HighlightField>

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class org.opensearch.client.opensearch.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
static HighlightField.Builder	builder()
boolean	equals(Object o)
int	hashCode()
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)
HighlightField.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Methods inherited from class org.opensearch.client.opensearch.core.search.HighlightBase

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.client.json.PlainJsonSerializable

toJsonString

Methods inherited from interface org.opensearch.client.util.ToCopyableBuilder

copy

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)

analyzer

@Nullable
public final Analyzer analyzer()

API name: analyzer

matchedFields

@Nonnull
public final List<String> matchedFields()

API name: matched_fields

serializeInternal

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

Overrides:

serializeInternal in class HighlightBase

toBuilder

@Nonnull
public HighlightField.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<HighlightField.Builder,HighlightField>

Returns:

a new builder instance.

builder

@Nonnull
public static HighlightField.Builder builder()

setupHighlightFieldDeserializer

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

hashCode

public int hashCode()

Overrides:

hashCode in class HighlightBase

equals

public boolean equals(Object o)

Overrides:

equals in class HighlightBase