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

Class CompletionSuggester

java.lang.Object

co.elastic.clients.elasticsearch.core.search.SuggesterBase

co.elastic.clients.elasticsearch.core.search.CompletionSuggester

All Implemented Interfaces:

FieldSuggesterVariant, JsonpSerializable

@JsonpDeserializable
public class CompletionSuggester
extends SuggesterBase
implements FieldSuggesterVariant

See Also:

• API specification

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch.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.
final Map<String,List<CompletionContext>>	contexts()	A value, geo point object, or a geo hash string to filter or boost the suggestion on.
final SuggestFuzziness	fuzzy()	Enables fuzziness, meaning you can have a typo in your search and still get results back.
static CompletionSuggester	of(Function<CompletionSuggester.Builder,ObjectBuilder<CompletionSuggester>> fn)
final RegexOptions	regex()	A regex query that expresses a prefix as a regular expression.
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupCompletionSuggesterDeserializer(ObjectDeserializer<CompletionSuggester.Builder> op)
final Boolean	skipDuplicates()	Whether duplicate suggestions should be filtered out.

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

analyzer, field, serialize, setupSuggesterBaseDeserializer, size, 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.FieldSuggesterVariant

_toFieldSuggester

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

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

A value, geo point object, or a geo hash string to filter or boost the suggestion on.

API name: contexts

fuzzy

@Nullable
public final SuggestFuzziness fuzzy()

Enables fuzziness, meaning you can have a typo in your search and still get results back.

API name: fuzzy

regex

@Nullable
public final RegexOptions regex()

A regex query that expresses a prefix as a regular expression.

API name: regex

skipDuplicates

@Nullable
public final Boolean skipDuplicates()

Whether duplicate suggestions should be filtered out.

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)