CompletionSuggest (java-client 8.3.3 API)

java.lang.Object

co.elastic.clients.elasticsearch.core.search.SuggestBase

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

All Implemented Interfaces:: SuggestionVariant, JsonpSerializable

@JsonpDeserializable
public class CompletionSuggest<TDocument>
extends SuggestBase
implements SuggestionVariant

See Also:: API specification

Nested Class Summary

Nested Classes

Modifier and Type Class Description

static class CompletionSuggest.Builder<TDocument>
Builder for CompletionSuggest.

Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch.core.search.SuggestBase
SuggestBase.AbstractBuilder<BuilderT extends SuggestBase.AbstractBuilder<BuilderT>>

Field Summary

Fields
Modifier and Type	Field	Description
`static JsonpDeserializer<CompletionSuggest<java.lang.Object>>`	`_DESERIALIZER`	Json deserializer for `CompletionSuggest` based on named deserializers provided by the calling `JsonMapper`.

Method Summary

Modifier and Type	Method	Description
`Suggestion.Kind`	`_suggestionKind()`	Suggestion variant kind.
`static <TDocument> JsonpDeserializer<CompletionSuggest<TDocument>>`	`createCompletionSuggestDeserializer(JsonpDeserializer<TDocument> tDocumentDeserializer)`	Create a JSON deserializer for CompletionSuggest
`static <TDocument> CompletionSuggest<TDocument>`	`of(java.util.function.Function<CompletionSuggest.Builder<TDocument>,ObjectBuilder<CompletionSuggest<TDocument>>> fn)`
`java.util.List<CompletionSuggestOption<TDocument>>`	`options()`	Required - API name: `options`
`protected void`	`serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)`
`protected static <TDocument> void`	`setupCompletionSuggestDeserializer(ObjectDeserializer<CompletionSuggest.Builder<TDocument>> op, JsonpDeserializer<TDocument> tDocumentDeserializer)`

Methods inherited from class co.elastic.clients.elasticsearch.core.search.SuggestBase

length, offset, serialize, setupSuggestBaseDeserializer, text, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface co.elastic.clients.elasticsearch.core.search.SuggestionVariant

_toSuggestion

Field Details
- _DESERIALIZER
  
  public static final JsonpDeserializer<CompletionSuggest<java.lang.Object>> _DESERIALIZER
  
  Json deserializer for CompletionSuggest based on named deserializers provided by the calling JsonMapper.
Method Details
- of
  
  public static <TDocument> CompletionSuggest<TDocument> of(java.util.function.Function<CompletionSuggest.Builder<TDocument>,ObjectBuilder<CompletionSuggest<TDocument>>> fn)
- _suggestionKind
  
  public Suggestion.Kind _suggestionKind()
  
  Suggestion variant kind.
  
  Specified by:
  
  _suggestionKind in interface SuggestionVariant
- options
  
  public final java.util.List<CompletionSuggestOption<TDocument>> options()
  
  Required - API name: options
- serializeInternal
  
  protected void serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
  
  Overrides:
  
  serializeInternal in class SuggestBase
- createCompletionSuggestDeserializer
  
  public static <TDocument> JsonpDeserializer<CompletionSuggest<TDocument>> createCompletionSuggestDeserializer(JsonpDeserializer<TDocument> tDocumentDeserializer)
  
  Create a JSON deserializer for CompletionSuggest
- setupCompletionSuggestDeserializer
  
  protected static <TDocument> void setupCompletionSuggestDeserializer(ObjectDeserializer<CompletionSuggest.Builder<TDocument>> op, JsonpDeserializer<TDocument> tDocumentDeserializer)