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

Class CompletionSuggest<TDocument>

java.lang.Object

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

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

All Implemented Interfaces:

JsonpSerializable, PlainJsonSerializable, SuggestVariant, ToCopyableBuilder<CompletionSuggest.Builder<TDocument>,CompletionSuggest<TDocument>>

@Generated("org.opensearch.client.codegen.CodeGenerator")
public class CompletionSuggest<TDocument>
extends SuggestBase
implements SuggestVariant, ToCopyableBuilder<CompletionSuggest.Builder<TDocument>,CompletionSuggest<TDocument>>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CompletionSuggest.Builder<TDocument>	Builder for CompletionSuggest.

Nested classes/interfaces inherited from class org.opensearch.client.opensearch.core.search.SuggestBase

SuggestBase.AbstractBuilder<BuilderT extends SuggestBase.AbstractBuilder<BuilderT>>

Method Summary

Modifier and Type	Method	Description
Suggest.Kind	_suggestKind()	Suggest variant kind.
static <TDocument> CompletionSuggest.Builder	builder()
static <TDocument> JsonpDeserializer<CompletionSuggest<TDocument>>	createCompletionSuggestDeserializer(JsonpDeserializer<TDocument> tDocumentDeserializer)	Create a JSON deserializer for CompletionSuggest.
boolean	equals(Object o)
int	hashCode()
static <TDocument> CompletionSuggest<TDocument>	of(Function<CompletionSuggest.Builder<TDocument>,ObjectBuilder<CompletionSuggest<TDocument>>> fn)
final 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)
CompletionSuggest.Builder<TDocument>	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.SuggestBase

length, offset, serialize, setupSuggestBaseDeserializer, text

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.opensearch.core.search.SuggestVariant

toSuggest

Methods inherited from interface org.opensearch.client.util.ToCopyableBuilder

copy

Method Details

of

public static <TDocument>
CompletionSuggest<TDocument> of(Function<CompletionSuggest.Builder<TDocument>,ObjectBuilder<CompletionSuggest<TDocument>>> fn)

_suggestKind

public Suggest.Kind _suggestKind()

Suggest variant kind.

Specified by:

_suggestKind in interface SuggestVariant

options

@Nonnull
public final List<CompletionSuggestOption<TDocument>> options()

Required - API name: options

serializeInternal

protected void serializeInternal(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

Overrides:

serializeInternal in class SuggestBase

toBuilder

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

Returns:

a new builder instance.

builder

@Nonnull
public static <TDocument> CompletionSuggest.Builder builder()

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)

hashCode

public int hashCode()

Overrides:

hashCode in class SuggestBase

equals

public boolean equals(Object o)

Overrides:

equals in class SuggestBase