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

Class Highlight

java.lang.Object

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

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

All Implemented Interfaces:

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

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

Nested Class Summary

Nested Classes

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

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

Method Summary

Modifier and Type	Method	Description
static Highlight.Builder	builder()
final HighlighterEncoder	encoder()	API name: encoder
boolean	equals(Object o)
final Map<String,HighlightField>	fields()	Required - API name: fields
int	hashCode()
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)
Highlight.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<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

@Nonnull
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

toBuilder

@Nonnull
public Highlight.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<Highlight.Builder,Highlight>

Returns:

a new builder instance.

builder

@Nonnull
public static Highlight.Builder builder()

setupHighlightDeserializer

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

hashCode

public int hashCode()

Overrides:

hashCode in class HighlightBase

equals

public boolean equals(Object o)

Overrides:

equals in class HighlightBase