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

Class SuggestBase

java.lang.Object

org.opensearch.client.opensearch.core.search.SuggestBase

All Implemented Interfaces:

JsonpSerializable, PlainJsonSerializable

Direct Known Subclasses:

CompletionSuggest, PhraseSuggest, TermSuggest

public abstract class SuggestBase
extends Object
implements PlainJsonSerializable

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SuggestBase.AbstractBuilder<BuilderT extends SuggestBase.AbstractBuilder<BuilderT>>	Builder for SuggestBase.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	SuggestBase(SuggestBase.AbstractBuilder<?> builder)

Method Summary

Modifier and Type	Method	Description
final int	length()	Required - API name: length
final int	offset()	Required - API name: offset
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 <BuilderT extends SuggestBase.AbstractBuilder<BuilderT>> void	setupSuggestBaseDeserializer(ObjectDeserializer<BuilderT> op)
final String	text()	Required - API name: text

Methods inherited from class java.lang.Object

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

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

toJsonString

Constructor Details

SuggestBase

protected SuggestBase(SuggestBase.AbstractBuilder<?> builder)

Method Details

length

public final int length()

Required - API name: length

offset

public final int offset()

Required - API name: offset

text

public final String text()

Required - API name: text

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)

setupSuggestBaseDeserializer

protected static <BuilderT extends SuggestBase.AbstractBuilder<BuilderT>>
void setupSuggestBaseDeserializer(ObjectDeserializer<BuilderT> op)