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:

CopyableBuilder<CompletionSuggestOption.Builder<TDocument>,CompletionSuggestOption<TDocument>>, MutableBuilder<CompletionSuggestOption.Builder<TDocument>,CompletionSuggestOption<TDocument>>, ObjectBuilder<CompletionSuggestOption<TDocument>>

Enclosing class:

CompletionSuggestOption<TDocument>

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

Builder for CompletionSuggestOption.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CompletionSuggestOption<TDocument>	build()	Builds a CompletionSuggestOption.
final CompletionSuggestOption.Builder<TDocument>	collateMatch(Boolean value)	API name: collate_match
final CompletionSuggestOption.Builder<TDocument>	contexts(String key, List<Context> value)	API name: contexts
final CompletionSuggestOption.Builder<TDocument>	contexts(Map<String,List<Context>> map)	API name: contexts
CompletionSuggestOption.Builder<TDocument>	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final CompletionSuggestOption.Builder<TDocument>	fields(String key, JsonData value)	API name: fields
final CompletionSuggestOption.Builder<TDocument>	fields(Map<String,JsonData> map)	API name: fields
final CompletionSuggestOption.Builder<TDocument>	id(String value)	API name: _id
final CompletionSuggestOption.Builder<TDocument>	index(String value)	API name: _index
final CompletionSuggestOption.Builder<TDocument>	routing(String value)	API name: _routing
final CompletionSuggestOption.Builder<TDocument>	score(Float value)	API name: _score
final CompletionSuggestOption.Builder<TDocument>	source(TDocument value)	API name: _source
final CompletionSuggestOption.Builder<TDocument>	tDocumentSerializer(JsonpSerializer<TDocument> value)	Serializer for TDocument.
final CompletionSuggestOption.Builder<TDocument>	text(String value)	Required - API name: text

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

_checkSingleUse, _listAdd, _listAddAll, _listCopy, _mapCopy, _mapPut, _mapPutAll

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.util.MutableBuilder

applyMutation

Constructor Details

Builder

public Builder()

Method Details

copy

@Nonnull
public CompletionSuggestOption.Builder<TDocument> copy()

Description copied from interface: CopyableBuilder

Create a new builder CopyableBuilder that is a copy of this one.

Specified by:

copy in interface CopyableBuilder<CompletionSuggestOption.Builder<TDocument>,CompletionSuggestOption<TDocument>>

Returns:

a new builder instance.

collateMatch

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

API name: collate_match

contexts

@Nonnull
public final CompletionSuggestOption.Builder<TDocument> contexts(Map<String,List<Context>> map)

API name: contexts

Adds all elements of map to contexts.

contexts

@Nonnull
public final CompletionSuggestOption.Builder<TDocument> contexts(String key,
 List<Context> value)

API name: contexts

Adds an entry to contexts.

fields

@Nonnull
public final CompletionSuggestOption.Builder<TDocument> fields(Map<String,JsonData> map)

API name: fields

Adds all elements of map to fields.

fields

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

API name: fields

Adds an entry to fields.

id

@Nonnull
public final CompletionSuggestOption.Builder<TDocument> id(@Nullable
 String value)

API name: _id

index

@Nonnull
public final CompletionSuggestOption.Builder<TDocument> index(@Nullable
 String value)

API name: _index

routing

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

API name: _routing

score

@Nonnull
public final CompletionSuggestOption.Builder<TDocument> score(@Nullable
 Float value)

API name: _score

source

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

API name: _source

tDocumentSerializer

@Nonnull
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.

text

@Nonnull
public final CompletionSuggestOption.Builder<TDocument> text(String value)

Required - API name: text

build

@Nonnull
public CompletionSuggestOption<TDocument> build()

Builds a CompletionSuggestOption.

Specified by:

build in interface ObjectBuilder<TDocument>

Throws:

NullPointerException - if some of the required fields are null.