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

Class FieldSuggester

java.lang.Object

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

All Implemented Interfaces:

JsonpSerializable, PlainJsonSerializable, TaggedUnion<FieldSuggester.Kind,FieldSuggesterVariant>

@JsonpDeserializable
@Generated("org.opensearch.client.codegen.CodeGenerator")
public class FieldSuggester
extends Object
implements TaggedUnion<FieldSuggester.Kind,FieldSuggesterVariant>, PlainJsonSerializable

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
final FieldSuggesterVariant	_get()
final FieldSuggester.Kind	_kind()	Get the of the kind of variant held by this object.
static FieldSuggester.Builder	builder()
CompletionSuggester	completion()	Get the completion variant value.
boolean	equals(Object o)
int	hashCode()
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()	API name: prefix
final 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.
final String	text()	API name: text
FieldSuggester.Builder	toBuilder()

Methods inherited from class java.lang.Object

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

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

toJsonString

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,FieldSuggesterVariant>

Returns:

the variant kind

_get

public final FieldSuggesterVariant _get()

Specified by:

_get in interface TaggedUnion<FieldSuggester.Kind,FieldSuggesterVariant>

of

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

prefix

@Nullable
public final String prefix()

API name: prefix

regex

@Nullable
public final String regex()

API name: regex

text

@Nullable
public final 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:

IllegalStateException - if the current variant is not 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 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 the term kind.

serialize

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

Specified by:

serialize in interface JsonpSerializable

toBuilder

@Nonnull
public FieldSuggester.Builder toBuilder()

builder

@Nonnull
public static FieldSuggester.Builder builder()

setupFieldSuggesterDeserializer

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object