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

Class CompletionSuggest.Builder<TDocument>

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.core.search.SuggestBase.AbstractBuilder<CompletionSuggest.Builder<TDocument>>

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

All Implemented Interfaces:

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

Enclosing class:

CompletionSuggest<TDocument>

public static class CompletionSuggest.Builder<TDocument>
extends SuggestBase.AbstractBuilder<CompletionSuggest.Builder<TDocument>>
implements CopyableBuilder<CompletionSuggest.Builder<TDocument>,CompletionSuggest<TDocument>>

Builder for CompletionSuggest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CompletionSuggest<TDocument>	build()	Builds a CompletionSuggest.
CompletionSuggest.Builder<TDocument>	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final CompletionSuggest.Builder<TDocument>	options(Function<CompletionSuggestOption.Builder<TDocument>,ObjectBuilder<CompletionSuggestOption<TDocument>>> fn)	Required - API name: options
final CompletionSuggest.Builder<TDocument>	options(List<CompletionSuggestOption<TDocument>> list)	Required - API name: options
final CompletionSuggest.Builder<TDocument>	options(CompletionSuggestOption<TDocument> value, CompletionSuggestOption<TDocument>... values)	Required - API name: options
protected CompletionSuggest.Builder<TDocument>	self()

Methods inherited from class org.opensearch.client.opensearch.core.search.SuggestBase.AbstractBuilder

length, offset, 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 CompletionSuggest.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<CompletionSuggest.Builder<TDocument>,CompletionSuggest<TDocument>>

Returns:

a new builder instance.

self

@Nonnull
protected CompletionSuggest.Builder<TDocument> self()

Specified by:

self in class SuggestBase.AbstractBuilder<CompletionSuggest.Builder<TDocument>>

options

@Nonnull
public final CompletionSuggest.Builder<TDocument> options(List<CompletionSuggestOption<TDocument>> list)

Required - API name: options

Adds all elements of list to options.

options

@Nonnull
public final CompletionSuggest.Builder<TDocument> options(CompletionSuggestOption<TDocument> value,
 CompletionSuggestOption<TDocument>... values)

Required - API name: options

Adds one or more values to options.

options

@Nonnull
public final CompletionSuggest.Builder<TDocument> options(Function<CompletionSuggestOption.Builder<TDocument>,ObjectBuilder<CompletionSuggestOption<TDocument>>> fn)

Required - API name: options

Adds a value to options using a builder lambda.

build

@Nonnull
public CompletionSuggest<TDocument> build()

Builds a CompletionSuggest.

Specified by:

build in interface ObjectBuilder<TDocument>

Throws:

NullPointerException - if some of the required fields are null.