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

Class FieldSuggester

java.lang.Object

org.opensearch.client.opensearch.core.search.FieldSuggester

All Implemented Interfaces:

JsonpSerializable, TaggedUnion<FieldSuggester.Kind,java.lang.Object>

@JsonpDeserializable
public class FieldSuggester
extends java.lang.Object
implements TaggedUnion<FieldSuggester.Kind,java.lang.Object>, JsonpSerializable

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
static JsonpDeserializer<FieldSuggester>	_DESERIALIZER

Constructor Summary

Constructors

Constructor	Description
FieldSuggester(FieldSuggesterVariant value)

Method Summary

Modifier and Type	Method	Description
java.lang.Object	_get()
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(java.util.function.Function<FieldSuggester.Builder,ObjectBuilder<FieldSuggester>> fn)
PhraseSuggester	phrase()	Get the phrase variant value.
java.lang.String	prefix()	API name: prefix
java.lang.String	regex()	API name: regex
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupFieldSuggesterDeserializer(ObjectDeserializer<FieldSuggester.Builder> op)
TermSuggester	term()	Get the term variant value.
java.lang.String	text()	API name: text

Methods inherited from class java.lang.Object

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

Field Detail

_DESERIALIZER

public static final JsonpDeserializer<FieldSuggester> _DESERIALIZER

Constructor Detail

FieldSuggester

public FieldSuggester(FieldSuggesterVariant value)

Method Detail

_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,java.lang.Object>

Returns:

the variant kind

_get

public final java.lang.Object _get()

Specified by:

_get in interface TaggedUnion<FieldSuggester.Kind,java.lang.Object>

of

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

prefix

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

API name: prefix

regex

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

API name: regex

text

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

API name: text

isCompletion

public boolean isCompletion()

Is this variant instance of kind completion?

completion

public CompletionSuggester completion()

Get the completion variant value.

Throws:

java.lang.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:

java.lang.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:

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

serialize

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

Specified by:

serialize in interface JsonpSerializable

setupFieldSuggesterDeserializer

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