Package co.elastic.clients.elasticsearch.core.search

Class Suggestion<TDocument>

java.lang.Object

co.elastic.clients.elasticsearch.core.search.Suggestion<TDocument>

All Implemented Interfaces:

JsonpSerializable, TaggedUnion<Suggestion.Kind,SuggestionVariant>

public class Suggestion<TDocument>
extends java.lang.Object
implements TaggedUnion<Suggestion.Kind,SuggestionVariant>, JsonpSerializable

See Also:

API specification

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Suggestion.Builder<TDocument>
static class	Suggestion.Kind	Suggestion variant kinds.

Constructor Summary

Constructors

Constructor	Description
Suggestion(SuggestionVariant value)

Method Summary

Modifier and Type	Method	Description
SuggestionVariant	_get()
Suggestion.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<Suggestion<TDocument>>	createSuggestionDeserializer(JsonpDeserializer<TDocument> tDocumentDeserializer)	Create a JSON deserializer for Suggestion
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> Suggestion<TDocument>	of(java.util.function.Function<Suggestion.Builder<TDocument>,ObjectBuilder<Suggestion<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 Details

Suggestion

public Suggestion(SuggestionVariant value)

Method Details

_kind

public final Suggestion.Kind _kind()

Description copied from interface: TaggedUnion

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

Specified by:

_kind in interface TaggedUnion<Suggestion.Kind,SuggestionVariant>

Returns:

the variant kind

_get

public final SuggestionVariant _get()

Specified by:

_get in interface TaggedUnion<Suggestion.Kind,SuggestionVariant>

of

public static <TDocument> Suggestion<TDocument> of(java.util.function.Function<Suggestion.Builder<TDocument>,ObjectBuilder<Suggestion<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

createSuggestionDeserializer

public static <TDocument>
ExternallyTaggedUnion.TypedKeysDeserializer<Suggestion<TDocument>> createSuggestionDeserializer(JsonpDeserializer<TDocument> tDocumentDeserializer)

Create a JSON deserializer for Suggestion