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

public class CompletionSuggestOption<TDocument>
extends Object
implements PlainJsonSerializable

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
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
final Map<String,JsonData>	fields()	API name: fields
final String	id()	Required - API name: _id
final String	index()	Required - API name: _index
static <TDocument> CompletionSuggestOption<TDocument>	of(Function<CompletionSuggestOption.Builder<TDocument>,ObjectBuilder<CompletionSuggestOption<TDocument>>> fn)
final String	routing()	API name: _routing
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 <TDocument> void	setupCompletionSuggestOptionDeserializer(ObjectDeserializer<CompletionSuggestOption.Builder<TDocument>> op, JsonpDeserializer<TDocument> tDocumentDeserializer)
final TDocument	source()	Required - API name: _source
final String	text()	Required - API name: text

Methods inherited from class java.lang.Object

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

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

toJsonString

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

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

API name: contexts

fields

public final Map<String,JsonData> fields()

API name: fields

id

public final String id()

Required - API name: _id

index

public final String index()

Required - API name: _index

routing

@Nullable
public final String routing()

API name: _routing

score

public final double score()

Required - API name: _score

source

public final TDocument source()

Required - API name: _source

text

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)

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)