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

Class TermSuggestOption

java.lang.Object

org.opensearch.client.opensearch.core.search.TermSuggestOption

All Implemented Interfaces:

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

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

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
static TermSuggestOption.Builder	builder()
final Boolean	collateMatch()	API name: collate_match
boolean	equals(Object o)
final Long	freq()	API name: freq
int	hashCode()
final String	highlighted()	API name: highlighted
static TermSuggestOption	of(Function<TermSuggestOption.Builder,ObjectBuilder<TermSuggestOption>> fn)
final double	score()	Required - API name: score
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	setupTermSuggestOptionDeserializer(ObjectDeserializer<TermSuggestOption.Builder> op)
final String	text()	Required - API name: text
TermSuggestOption.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<TermSuggestOption> _DESERIALIZER

Json deserializer for TermSuggestOption

Method Details

of

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

collateMatch

@Nullable
public final Boolean collateMatch()

API name: collate_match

freq

@Nullable
public final Long freq()

API name: freq

highlighted

@Nullable
public final String highlighted()

API name: highlighted

score

public final double score()

Required - API name: score

text

@Nonnull
public final String text()

Required - 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 TermSuggestOption.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<TermSuggestOption.Builder,TermSuggestOption>

Returns:

a new builder instance.

builder

@Nonnull
public static TermSuggestOption.Builder builder()

setupTermSuggestOptionDeserializer

protected static void setupTermSuggestOptionDeserializer(ObjectDeserializer<TermSuggestOption.Builder> op)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object