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

Class CompletionSuggester

java.lang.Object

org.opensearch.client.opensearch.core.search.SuggesterBase

org.opensearch.client.opensearch.core.search.CompletionSuggester

All Implemented Interfaces:

JsonpSerializable, FieldSuggesterVariant

@JsonpDeserializable
public class CompletionSuggester
extends SuggesterBase
implements FieldSuggesterVariant

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CompletionSuggester.Builder	Builder for CompletionSuggester.

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

SuggesterBase.AbstractBuilder<BuilderT extends SuggesterBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static JsonpDeserializer<CompletionSuggester>	_DESERIALIZER	Json deserializer for CompletionSuggester

Method Summary

Modifier and Type	Method	Description
FieldSuggester.Kind	_fieldSuggesterKind()	FieldSuggester variant kind.
java.util.Map<java.lang.String,java.util.List<CompletionContext>>	contexts()	API name: contexts
SuggestFuzziness	fuzzy()	API name: fuzzy
static CompletionSuggester	of(java.util.function.Function<CompletionSuggester.Builder,ObjectBuilder<CompletionSuggester>> fn)
java.lang.String	prefix()	API name: prefix
java.lang.String	regex()	API name: regex
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupCompletionSuggesterDeserializer(ObjectDeserializer<CompletionSuggester.Builder> op)
java.lang.Boolean	skipDuplicates()	API name: skip_duplicates

Methods inherited from class org.opensearch.client.opensearch.core.search.SuggesterBase

analyzer, field, serialize, setupSuggesterBaseDeserializer, size

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

_toFieldSuggester

Field Detail

_DESERIALIZER

public static final JsonpDeserializer<CompletionSuggester> _DESERIALIZER

Json deserializer for CompletionSuggester

Method Detail

of

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

_fieldSuggesterKind

public FieldSuggester.Kind _fieldSuggesterKind()

FieldSuggester variant kind.

Specified by:

_fieldSuggesterKind in interface FieldSuggesterVariant

contexts

public final java.util.Map<java.lang.String,java.util.List<CompletionContext>> contexts()

API name: contexts

fuzzy

@Nullable
public final SuggestFuzziness fuzzy()

API name: fuzzy

prefix

@Nullable
public final java.lang.String prefix()

API name: prefix

regex

@Nullable
public final java.lang.String regex()

API name: regex

skipDuplicates

@Nullable
public final java.lang.Boolean skipDuplicates()

API name: skip_duplicates

serializeInternal

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

Overrides:

serializeInternal in class SuggesterBase

setupCompletionSuggesterDeserializer

protected static void setupCompletionSuggesterDeserializer(ObjectDeserializer<CompletionSuggester.Builder> op)