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

Class Suggester

java.lang.Object

org.opensearch.client.opensearch.core.search.Suggester

All Implemented Interfaces:

JsonpSerializable, PlainJsonSerializable, ToCopyableBuilder<Suggester.Builder,Suggester>

@JsonpDeserializable
@Generated("org.opensearch.client.codegen.CodeGenerator")
public class Suggester
extends Object
implements PlainJsonSerializable, ToCopyableBuilder<Suggester.Builder,Suggester>

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
static final JsonpDeserializer<Suggester>	_DESERIALIZER	Json deserializer for Suggester

Method Summary

Modifier and Type	Method	Description
static Suggester.Builder	builder()
boolean	equals(Object o)
int	hashCode()
static Suggester	of(Function<Suggester.Builder,ObjectBuilder<Suggester>> fn)
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this object to JSON.
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupSuggesterDeserializer(ObjectDeserializer<Suggester.Builder> op)
final Map<String,FieldSuggester>	suggesters()	The named suggesters.
final String	text()	The global suggest text, which avoids repetition when the same text is used in several suggesters.
Suggester.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

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

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

copy

Field Details

_DESERIALIZER

public static final JsonpDeserializer<Suggester> _DESERIALIZER

Json deserializer for Suggester

Method Details

of

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

suggesters

@Nonnull
public final Map<String,FieldSuggester> suggesters()

The named suggesters.

text

@Nullable
public final String text()

The global suggest text, which avoids repetition when the same text is used in several suggesters.

API name: text

serialize

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

Serialize this object to JSON.

Specified by:

serialize in interface JsonpSerializable

serializeInternal

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

toBuilder

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

Returns:

a new builder instance.

builder

@Nonnull
public static Suggester.Builder builder()

setupSuggesterDeserializer

protected static void setupSuggesterDeserializer(ObjectDeserializer<Suggester.Builder> op)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object