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

Class CompletionSuggestOption<TDocument>

java.lang.Object

org.opensearch.client.opensearch.core.search.CompletionSuggestOption<TDocument>

All Implemented Interfaces:

JsonpSerializable, PlainJsonSerializable, ToCopyableBuilder<CompletionSuggestOption.Builder<TDocument>,CompletionSuggestOption<TDocument>>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CompletionSuggestOption.Builder<TDocument>	Builder for CompletionSuggestOption.

Method Summary

Modifier and Type	Method	Description
static <TDocument> CompletionSuggestOption.Builder	builder()
final Boolean	collateMatch()	API name: collate_match
final Map<String,List<Context>>	contexts()	API name: contexts
static <TDocument> JsonpDeserializer<CompletionSuggestOption<TDocument>>	createCompletionSuggestOptionDeserializer(JsonpDeserializer<TDocument> tDocumentDeserializer)	Create a JSON deserializer for CompletionSuggestOption.
boolean	equals(Object o)
final Map<String,JsonData>	fields()	API name: fields
int	hashCode()
final String	id()	API name: _id
final String	index()	API name: _index
static <TDocument> CompletionSuggestOption<TDocument>	of(Function<CompletionSuggestOption.Builder<TDocument>,ObjectBuilder<CompletionSuggestOption<TDocument>>> fn)
final String	routing()	API name: _routing
final Float	score()	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 <TDocument> void	setupCompletionSuggestOptionDeserializer(ObjectDeserializer<CompletionSuggestOption.Builder<TDocument>> op, JsonpDeserializer<TDocument> tDocumentDeserializer)
final TDocument	source()	API name: _source
final JsonpSerializer<TDocument>	tDocumentSerializer()	Serializer for TDocument.
final String	text()	Required - API name: text
CompletionSuggestOption.Builder<TDocument>	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

Method Details

of

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

collateMatch

@Nullable
public final Boolean collateMatch()

API name: collate_match

contexts

@Nonnull
public final Map<String,List<Context>> contexts()

API name: contexts

fields

@Nonnull
public final Map<String,JsonData> fields()

API name: fields

id

@Nullable
public final String id()

API name: _id

index

@Nullable
public final String index()

API name: _index

routing

@Nullable
public final String routing()

API name: _routing

score

@Nullable
public final Float score()

API name: _score

source

@Nullable
public final TDocument source()

API name: _source

tDocumentSerializer

@Nullable
public final JsonpSerializer<TDocument> tDocumentSerializer()

Serializer for TDocument. If not set, an attempt will be made to find a serializer from the JSON context.

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 CompletionSuggestOption.Builder<TDocument> 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<CompletionSuggestOption.Builder<TDocument>,CompletionSuggestOption<TDocument>>

Returns:

a new builder instance.

builder

@Nonnull
public static <TDocument>
CompletionSuggestOption.Builder builder()

createCompletionSuggestOptionDeserializer

public static <TDocument>
JsonpDeserializer<CompletionSuggestOption<TDocument>> createCompletionSuggestOptionDeserializer(JsonpDeserializer<TDocument> tDocumentDeserializer)

Create a JSON deserializer for CompletionSuggestOption.

setupCompletionSuggestOptionDeserializer

protected static <TDocument> void setupCompletionSuggestOptionDeserializer(ObjectDeserializer<CompletionSuggestOption.Builder<TDocument>> op,
 JsonpDeserializer<TDocument> tDocumentDeserializer)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object