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

Class Suggester.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.core.search.Suggester.Builder

All Implemented Interfaces:

CopyableBuilder<Suggester.Builder,Suggester>, MutableBuilder<Suggester.Builder,Suggester>, ObjectBuilder<Suggester>

Enclosing class:

Suggester

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

Builder for Suggester.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
Suggester	build()	Builds a Suggester.
Suggester.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final Suggester.Builder	suggesters(String key, Function<FieldSuggester.Builder,ObjectBuilder<FieldSuggester>> fn)	The named suggesters.
final Suggester.Builder	suggesters(String key, FieldSuggester value)	The named suggesters.
final Suggester.Builder	suggesters(Map<String,FieldSuggester> map)	The named suggesters.
final Suggester.Builder	text(String value)	The global suggest text, which avoids repetition when the same text is used in several suggesters.

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 Suggester.Builder copy()

Description copied from interface: CopyableBuilder

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

Specified by:

copy in interface CopyableBuilder<Suggester.Builder,Suggester>

Returns:

a new builder instance.

suggesters

@Nonnull
public final Suggester.Builder suggesters(Map<String,FieldSuggester> map)

The named suggesters.

Adds all elements of map to suggesters.

suggesters

@Nonnull
public final Suggester.Builder suggesters(String key,
 FieldSuggester value)

The named suggesters.

Adds an entry to suggesters.

suggesters

@Nonnull
public final Suggester.Builder suggesters(String key,
 Function<FieldSuggester.Builder,ObjectBuilder<FieldSuggester>> fn)

The named suggesters.

Adds a value to suggesters using a builder lambda.

text

@Nonnull
public final Suggester.Builder text(@Nullable
 String value)

The global suggest text, which avoids repetition when the same text is used in several suggesters.

API name: text

build

@Nonnull
public Suggester build()

Builds a Suggester.

Specified by:

build in interface ObjectBuilder<Suggester>

Throws:

NullPointerException - if some of the required fields are null.