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

Class FieldSuggester

java.lang.Object

co.elastic.clients.elasticsearch.core.search.FieldSuggester

All Implemented Interfaces:

JsonpSerializable, OpenTaggedUnion<FieldSuggester.Kind,Object>, TaggedUnion<FieldSuggester.Kind,Object>

@JsonpDeserializable
public class FieldSuggester
extends Object
implements OpenTaggedUnion<FieldSuggester.Kind,Object>, JsonpSerializable

See Also:

• API specification

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FieldSuggester.Builder
static enum	FieldSuggester.Kind	FieldSuggester variant kinds.

Field Summary

Fields

Modifier and Type	Field	Description
static final JsonpDeserializer<FieldSuggester>	_DESERIALIZER

Constructor Summary

Constructors

Constructor	Description
FieldSuggester(FieldSuggesterVariant value)

Method Summary

Modifier and Type	Method	Description
JsonData	_custom()	Get the custom plugin-defined variant value.
final String	_customKind()	Get the actual kind when _kind() equals FieldSuggester.Kind._Custom (plugin-defined variant).
final Object	_get()
boolean	_isCustom()	Is this a custom FieldSuggester defined by a plugin?
final FieldSuggester.Kind	_kind()	Get the of the kind of variant held by this object.
CompletionSuggester	completion()	Get the completion variant value.
boolean	isCompletion()	Is this variant instance of kind completion?
boolean	isPhrase()	Is this variant instance of kind phrase?
boolean	isTerm()	Is this variant instance of kind term?
static FieldSuggester	of(Function<FieldSuggester.Builder,ObjectBuilder<FieldSuggester>> fn)
PhraseSuggester	phrase()	Get the phrase variant value.
final String	prefix()	Prefix used to search for suggestions.
final String	regex()	A prefix expressed as a regular expression.
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupFieldSuggesterDeserializer(ObjectDeserializer<FieldSuggester.Builder> op)
TermSuggester	term()	Get the term variant value.
final String	text()	The text to use as input for the suggester.
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

_DESERIALIZER

public static final JsonpDeserializer<FieldSuggester> _DESERIALIZER

Constructor Details

FieldSuggester

public FieldSuggester(FieldSuggesterVariant value)

Method Details

_kind

public final FieldSuggester.Kind _kind()

Description copied from interface: TaggedUnion

Get the of the kind of variant held by this object.

Specified by:

_kind in interface TaggedUnion<FieldSuggester.Kind,Object>

Returns:

the variant kind

_get

public final Object _get()

Specified by:

_get in interface TaggedUnion<FieldSuggester.Kind,Object>

of

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

prefix

@Nullable
public final String prefix()

Prefix used to search for suggestions.

API name: prefix

regex

@Nullable
public final String regex()

A prefix expressed as a regular expression.

API name: regex

text

@Nullable
public final String text()

The text to use as input for the suggester. Needs to be set globally or per suggestion.

API name: text

isCompletion

public boolean isCompletion()

Is this variant instance of kind completion?

completion

public CompletionSuggester completion()

Get the completion variant value.

Throws:

IllegalStateException - if the current variant is not of the completion kind.

isPhrase

public boolean isPhrase()

Is this variant instance of kind phrase?

phrase

public PhraseSuggester phrase()

Get the phrase variant value.

Throws:

IllegalStateException - if the current variant is not of the phrase kind.

isTerm

public boolean isTerm()

Is this variant instance of kind term?

term

public TermSuggester term()

Get the term variant value.

Throws:

IllegalStateException - if the current variant is not of the term kind.

_isCustom

public boolean _isCustom()

Is this a custom FieldSuggester defined by a plugin?

_customKind

@Nullable
public final String _customKind()

Get the actual kind when _kind() equals FieldSuggester.Kind._Custom (plugin-defined variant).

Specified by:

_customKind in interface OpenTaggedUnion<FieldSuggester.Kind,Object>

_custom

public JsonData _custom()

Get the custom plugin-defined variant value.

Throws:

IllegalStateException - if the current variant is not FieldSuggester.Kind._Custom.

serialize

public void serialize(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

Specified by:

serialize in interface JsonpSerializable

toString

public String toString()

Overrides:

toString in class Object

setupFieldSuggesterDeserializer

protected static void setupFieldSuggesterDeserializer(ObjectDeserializer<FieldSuggester.Builder> op)