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

Class PhraseSuggest

java.lang.Object

org.opensearch.client.opensearch.core.search.SuggestBase

org.opensearch.client.opensearch.core.search.PhraseSuggest

All Implemented Interfaces:

JsonpSerializable, PlainJsonSerializable, SuggestVariant, ToCopyableBuilder<PhraseSuggest.Builder,PhraseSuggest>

@JsonpDeserializable
@Generated("org.opensearch.client.codegen.CodeGenerator")
public class PhraseSuggest
extends SuggestBase
implements SuggestVariant, ToCopyableBuilder<PhraseSuggest.Builder,PhraseSuggest>

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class org.opensearch.client.opensearch.core.search.SuggestBase

SuggestBase.AbstractBuilder<BuilderT extends SuggestBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
Suggest.Kind	_suggestKind()	Suggest variant kind.
static PhraseSuggest.Builder	builder()
boolean	equals(Object o)
int	hashCode()
static PhraseSuggest	of(Function<PhraseSuggest.Builder,ObjectBuilder<PhraseSuggest>> fn)
final List<PhraseSuggestOption>	options()	Required - API name: options
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupPhraseSuggestDeserializer(ObjectDeserializer<PhraseSuggest.Builder> op)
PhraseSuggest.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Methods inherited from class org.opensearch.client.opensearch.core.search.SuggestBase

length, offset, serialize, setupSuggestBaseDeserializer, text

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.opensearch.core.search.SuggestVariant

toSuggest

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

copy

Field Details

_DESERIALIZER

public static final JsonpDeserializer<PhraseSuggest> _DESERIALIZER

Json deserializer for PhraseSuggest

Method Details

of

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

_suggestKind

public Suggest.Kind _suggestKind()

Suggest variant kind.

Specified by:

_suggestKind in interface SuggestVariant

options

@Nonnull
public final List<PhraseSuggestOption> options()

Required - API name: options

serializeInternal

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

Overrides:

serializeInternal in class SuggestBase

toBuilder

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

Returns:

a new builder instance.

builder

@Nonnull
public static PhraseSuggest.Builder builder()

setupPhraseSuggestDeserializer

protected static void setupPhraseSuggestDeserializer(ObjectDeserializer<PhraseSuggest.Builder> op)

hashCode

public int hashCode()

Overrides:

hashCode in class SuggestBase

equals

public boolean equals(Object o)

Overrides:

equals in class SuggestBase