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

Class Suggest<TDocument>

java.lang.Object

org.opensearch.client.opensearch.core.search.Suggest<TDocument>

All Implemented Interfaces:

JsonpSerializable, TaggedUnion<Suggest.Kind,SuggestVariant>

public class Suggest<TDocument>
extends java.lang.Object
implements TaggedUnion<Suggest.Kind,SuggestVariant>, JsonpSerializable

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Suggest.Builder<TDocument>
static class	Suggest.Kind

Constructor Summary

Constructors

Constructor	Description
Suggest(SuggestVariant value)

Method Summary

Modifier and Type	Method	Description
SuggestVariant	_get()
Suggest.Kind	_kind()	Get the of the kind of variant held by this object.
CompletionSuggest<TDocument>	completion()	Get the completion variant value.
static <TDocument> ExternallyTaggedUnion.TypedKeysDeserializer<Suggest<TDocument>>	createSuggestDeserializer(JsonpDeserializer<TDocument> tDocumentDeserializer)
boolean	isCompletion()	Is this variant instance of kind completion?
boolean	isPhrase()	Is this variant instance of kind phrase?
boolean	isTerm()	Is this variant instance of kind term?
static <TDocument> Suggest<TDocument>	of(java.util.function.Function<Suggest.Builder<TDocument>,ObjectBuilder<Suggest<TDocument>>> fn)
PhraseSuggest	phrase()	Get the phrase variant value.
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
TermSuggest	term()	Get the term variant value.

Methods inherited from class java.lang.Object

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

Constructor Detail

Suggest

public Suggest(SuggestVariant value)

Method Detail

_kind

public final Suggest.Kind _kind()

Description copied from interface: TaggedUnion

Get the of the kind of variant held by this object.

Specified by:

_kind in interface TaggedUnion<Suggest.Kind,SuggestVariant>

Returns:

the variant kind

_get

public final SuggestVariant _get()

Specified by:

_get in interface TaggedUnion<Suggest.Kind,SuggestVariant>

of

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

isCompletion

public boolean isCompletion()

Is this variant instance of kind completion?

completion

public CompletionSuggest<TDocument> completion()

Get the completion variant value.

Throws:

java.lang.IllegalStateException - if the current variant is not of the completion kind.

isPhrase

public boolean isPhrase()

Is this variant instance of kind phrase?

phrase

public PhraseSuggest phrase()

Get the phrase variant value.

Throws:

java.lang.IllegalStateException - if the current variant is not of the phrase kind.

isTerm

public boolean isTerm()

Is this variant instance of kind term?

term

public TermSuggest term()

Get the term variant value.

Throws:

java.lang.IllegalStateException - if the current variant is not of the term kind.

serialize

public void serialize(jakarta.json.stream.JsonGenerator generator,
                      JsonpMapper mapper)

Specified by:

serialize in interface JsonpSerializable

createSuggestDeserializer

public static <TDocument> ExternallyTaggedUnion.TypedKeysDeserializer<Suggest<TDocument>> createSuggestDeserializer(JsonpDeserializer<TDocument> tDocumentDeserializer)