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

Class Suggestion.Builder<T>

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.core.search.Suggestion.Builder<T>

All Implemented Interfaces:

ObjectBuilder<Suggestion<T>>

Enclosing class:

Suggestion<T>

public static class Suggestion.Builder<T>
extends ObjectBuilderBase
implements ObjectBuilder<Suggestion<T>>

Builder for Suggestion.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
Suggestion<T>	build()	Builds a Suggestion.
Suggestion.Builder<T>	length(int value)	Required - API name: length
Suggestion.Builder<T>	offset(int value)	Required - API name: offset
Suggestion.Builder<T>	options(java.util.function.Function<SuggestOption.Builder<T>,ObjectBuilder<SuggestOption<T>>> fn)	Required - API name: options
Suggestion.Builder<T>	options(java.util.List<SuggestOption<T>> list)	Required - API name: options
Suggestion.Builder<T>	options(SuggestOption<T> value, SuggestOption<T>... values)	Required - API name: options
Suggestion.Builder<T>	text(java.lang.String value)	Required - API name: text
Suggestion.Builder<T>	tSerializer(JsonpSerializer<T> value)	Serializer for T.

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

length

public final Suggestion.Builder<T> length(int value)

Required - API name: length

offset

public final Suggestion.Builder<T> offset(int value)

Required - API name: offset

options

public final Suggestion.Builder<T> options(java.util.List<SuggestOption<T>> list)

Required - API name: options

Adds all elements of list to options.

options

public final Suggestion.Builder<T> options(SuggestOption<T> value,
                                           SuggestOption<T>... values)

Required - API name: options

Adds one or more values to options.

options

public final Suggestion.Builder<T> options(java.util.function.Function<SuggestOption.Builder<T>,ObjectBuilder<SuggestOption<T>>> fn)

Required - API name: options

Adds a value to options using a builder lambda.

text

public final Suggestion.Builder<T> text(java.lang.String value)

Required - API name: text

tSerializer

public final Suggestion.Builder<T> tSerializer(@Nullable
                                               JsonpSerializer<T> value)

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

build

public Suggestion<T> build()

Builds a Suggestion.

Specified by:

build in interface ObjectBuilder<T>

Throws:

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