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:

ObjectBuilder<Suggester>

Enclosing class:

Suggester

public static class Suggester.Builder
extends ObjectBuilderBase
implements ObjectBuilder<Suggester>

Builder for Suggester.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
Suggester	build()	Builds a Suggester.
Suggester.Builder	suggesters(java.lang.String key, java.util.function.Function<FieldSuggester.Builder,ObjectBuilder<FieldSuggester>> fn)	The named suggesters
Suggester.Builder	suggesters(java.lang.String key, FieldSuggester value)	The named suggesters
Suggester.Builder	suggesters(java.util.Map<java.lang.String,FieldSuggester> map)	The named suggesters
Suggester.Builder	text(java.lang.String value)	Global suggest text, to avoid repetition when the same text is used in several suggesters

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

suggesters

public final Suggester.Builder suggesters(java.util.Map<java.lang.String,FieldSuggester> map)

The named suggesters

Adds all entries of map to suggesters.

suggesters

public final Suggester.Builder suggesters(java.lang.String key,
                                          FieldSuggester value)

The named suggesters

Adds an entry to suggesters.

suggesters

public final Suggester.Builder suggesters(java.lang.String key,
                                          java.util.function.Function<FieldSuggester.Builder,ObjectBuilder<FieldSuggester>> fn)

The named suggesters

Adds an entry to suggesters using a builder lambda.

text

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

Global suggest text, to avoid repetition when the same text is used in several suggesters

API name: text

build

public Suggester build()

Builds a Suggester.

Specified by:

build in interface ObjectBuilder<Suggester>

Throws:

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