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, PlainJsonSerializable, FieldSuggesterVariant, ToCopyableBuilder<CompletionSuggester.Builder,CompletionSuggester>

@JsonpDeserializable
@Generated("org.opensearch.client.codegen.CodeGenerator")
public class CompletionSuggester
extends SuggesterBase
implements FieldSuggesterVariant, ToCopyableBuilder<CompletionSuggester.Builder,CompletionSuggester>

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 final JsonpDeserializer<CompletionSuggester>	_DESERIALIZER	Json deserializer for CompletionSuggester

Method Summary

Modifier and Type	Method	Description
FieldSuggester.Kind	_fieldSuggesterKind()	FieldSuggester variant kind.
static CompletionSuggester.Builder	builder()
final Map<String,List<CompletionContext>>	contexts()	API name: contexts
boolean	equals(Object o)
final SuggestFuzziness	fuzzy()	API name: fuzzy
int	hashCode()
static CompletionSuggester	of(Function<CompletionSuggester.Builder,ObjectBuilder<CompletionSuggester>> fn)
final String	regex()	API name: regex
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupCompletionSuggesterDeserializer(ObjectDeserializer<CompletionSuggester.Builder> op)
final Boolean	skipDuplicates()	API name: skip_duplicates
CompletionSuggester.Builder	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.SuggesterBase

analyzer, field, serialize, setupSuggesterBaseDeserializer, size

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.client.opensearch.core.search.FieldSuggesterVariant

toFieldSuggester

Methods inherited from interface org.opensearch.client.json.PlainJsonSerializable

toJsonString

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

copy

Field Details

_DESERIALIZER

public static final JsonpDeserializer<CompletionSuggester> _DESERIALIZER

Json deserializer for CompletionSuggester

Method Details

of

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

_fieldSuggesterKind

public FieldSuggester.Kind _fieldSuggesterKind()

FieldSuggester variant kind.

Specified by:

_fieldSuggesterKind in interface FieldSuggesterVariant

contexts

@Nonnull
public final Map<String,List<CompletionContext>> contexts()

API name: contexts

fuzzy

@Nullable
public final SuggestFuzziness fuzzy()

API name: fuzzy

regex

@Nullable
public final String regex()

API name: regex

skipDuplicates

@Nullable
public final Boolean skipDuplicates()

API name: skip_duplicates

serializeInternal

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

Overrides:

serializeInternal in class SuggesterBase

toBuilder

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

Returns:

a new builder instance.

builder

@Nonnull
public static CompletionSuggester.Builder builder()

setupCompletionSuggesterDeserializer

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

hashCode

public int hashCode()

Overrides:

hashCode in class SuggesterBase

equals

public boolean equals(Object o)

Overrides:

equals in class SuggesterBase