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

Class CompletionSuggestOption.Builder<TDocument>

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

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

All Implemented Interfaces:

ObjectBuilder<CompletionSuggestOption<TDocument>>

Enclosing class:

CompletionSuggestOption<TDocument>

public static class CompletionSuggestOption.Builder<TDocument>
extends ObjectBuilderBase
implements ObjectBuilder<CompletionSuggestOption<TDocument>>

Builder for CompletionSuggestOption.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CompletionSuggestOption<TDocument>	build()	Builds a CompletionSuggestOption.
CompletionSuggestOption.Builder<TDocument>	collateMatch(java.lang.Boolean value)	API name: collate_match
CompletionSuggestOption.Builder<TDocument>	contexts(java.lang.String key, java.util.List<Context> value)	API name: contexts
CompletionSuggestOption.Builder<TDocument>	contexts(java.util.Map<java.lang.String,java.util.List<Context>> map)	API name: contexts
CompletionSuggestOption.Builder<TDocument>	fields(java.lang.String key, JsonData value)	API name: fields
CompletionSuggestOption.Builder<TDocument>	fields(java.util.Map<java.lang.String,JsonData> map)	API name: fields
CompletionSuggestOption.Builder<TDocument>	id(java.lang.String value)	Required - API name: _id
CompletionSuggestOption.Builder<TDocument>	index(java.lang.String value)	Required - API name: _index
CompletionSuggestOption.Builder<TDocument>	routing(java.lang.String value)	API name: _routing
CompletionSuggestOption.Builder<TDocument>	score(double value)	Required - API name: _score
CompletionSuggestOption.Builder<TDocument>	source(TDocument value)	Required - API name: _source
CompletionSuggestOption.Builder<TDocument>	tDocumentSerializer(JsonpSerializer<TDocument> value)	Serializer for TDocument.
CompletionSuggestOption.Builder<TDocument>	text(java.lang.String value)	Required - API name: text

Methods inherited from class org.opensearch.client.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

collateMatch

public final CompletionSuggestOption.Builder<TDocument> collateMatch(@Nullable
                                                                     java.lang.Boolean value)

API name: collate_match

contexts

public final CompletionSuggestOption.Builder<TDocument> contexts(java.util.Map<java.lang.String,java.util.List<Context>> map)

API name: contexts

Adds all entries of map to contexts.

contexts

public final CompletionSuggestOption.Builder<TDocument> contexts(java.lang.String key,
                                                                 java.util.List<Context> value)

API name: contexts

Adds an entry to contexts.

fields

public final CompletionSuggestOption.Builder<TDocument> fields(java.util.Map<java.lang.String,JsonData> map)

API name: fields

Adds all entries of map to fields.

fields

public final CompletionSuggestOption.Builder<TDocument> fields(java.lang.String key,
                                                               JsonData value)

API name: fields

Adds an entry to fields.

id

public final CompletionSuggestOption.Builder<TDocument> id(java.lang.String value)

Required - API name: _id

index

public final CompletionSuggestOption.Builder<TDocument> index(java.lang.String value)

Required - API name: _index

routing

public final CompletionSuggestOption.Builder<TDocument> routing(@Nullable
                                                                java.lang.String value)

API name: _routing

score

public final CompletionSuggestOption.Builder<TDocument> score(double value)

Required - API name: _score

source

public final CompletionSuggestOption.Builder<TDocument> source(TDocument value)

Required - API name: _source

text

public final CompletionSuggestOption.Builder<TDocument> text(java.lang.String value)

Required - API name: text

tDocumentSerializer

public final CompletionSuggestOption.Builder<TDocument> tDocumentSerializer(@Nullable
                                                                            JsonpSerializer<TDocument> value)

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

build

public CompletionSuggestOption<TDocument> build()

Builds a CompletionSuggestOption.

Specified by:

build in interface ObjectBuilder<TDocument>

Throws:

java.lang.NullPointerException - if some of the required fields are null.