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

Class PhraseSuggester.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.core.search.SuggesterBase.AbstractBuilder<PhraseSuggester.Builder>

org.opensearch.client.opensearch.core.search.PhraseSuggester.Builder

All Implemented Interfaces:

ObjectBuilder<PhraseSuggester>

Enclosing class:

PhraseSuggester

public static class PhraseSuggester.Builder
extends SuggesterBase.AbstractBuilder<PhraseSuggester.Builder>
implements ObjectBuilder<PhraseSuggester>

Builder for PhraseSuggester.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
PhraseSuggester	build()	Builds a PhraseSuggester.
PhraseSuggester.Builder	collate(java.util.function.Function<PhraseSuggestCollate.Builder,ObjectBuilder<PhraseSuggestCollate>> fn)	API name: collate
PhraseSuggester.Builder	collate(PhraseSuggestCollate value)	API name: collate
PhraseSuggester.Builder	confidence(java.lang.Double value)	API name: confidence
PhraseSuggester.Builder	directGenerator(java.util.function.Function<DirectGenerator.Builder,ObjectBuilder<DirectGenerator>> fn)	API name: direct_generator
PhraseSuggester.Builder	directGenerator(java.util.List<DirectGenerator> list)	API name: direct_generator
PhraseSuggester.Builder	directGenerator(DirectGenerator value, DirectGenerator... values)	API name: direct_generator
PhraseSuggester.Builder	forceUnigrams(java.lang.Boolean value)	API name: force_unigrams
PhraseSuggester.Builder	gramSize(java.lang.Integer value)	API name: gram_size
PhraseSuggester.Builder	highlight(java.util.function.Function<PhraseSuggestHighlight.Builder,ObjectBuilder<PhraseSuggestHighlight>> fn)	API name: highlight
PhraseSuggester.Builder	highlight(PhraseSuggestHighlight value)	API name: highlight
PhraseSuggester.Builder	maxErrors(java.lang.Double value)	API name: max_errors
PhraseSuggester.Builder	realWordErrorLikelihood(java.lang.Double value)	API name: real_word_error_likelihood
protected PhraseSuggester.Builder	self()
PhraseSuggester.Builder	separator(java.lang.String value)	API name: separator
PhraseSuggester.Builder	shardSize(java.lang.Integer value)	API name: shard_size
PhraseSuggester.Builder	smoothing(java.util.function.Function<SmoothingModel.Builder,ObjectBuilder<SmoothingModel>> fn)	API name: smoothing
PhraseSuggester.Builder	smoothing(SmoothingModel value)	API name: smoothing
PhraseSuggester.Builder	text(java.lang.String value)	API name: text
PhraseSuggester.Builder	tokenLimit(java.lang.Integer value)	API name: token_limit

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

analyzer, field, size

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

collate

public final PhraseSuggester.Builder collate(@Nullable
                                             PhraseSuggestCollate value)

API name: collate

collate

public final PhraseSuggester.Builder collate(java.util.function.Function<PhraseSuggestCollate.Builder,ObjectBuilder<PhraseSuggestCollate>> fn)

API name: collate

confidence

public final PhraseSuggester.Builder confidence(@Nullable
                                                java.lang.Double value)

API name: confidence

directGenerator

public final PhraseSuggester.Builder directGenerator(java.util.List<DirectGenerator> list)

API name: direct_generator

Adds all elements of list to directGenerator.

directGenerator

public final PhraseSuggester.Builder directGenerator(DirectGenerator value,
                                                     DirectGenerator... values)

API name: direct_generator

Adds one or more values to directGenerator.

directGenerator

public final PhraseSuggester.Builder directGenerator(java.util.function.Function<DirectGenerator.Builder,ObjectBuilder<DirectGenerator>> fn)

API name: direct_generator

Adds a value to directGenerator using a builder lambda.

forceUnigrams

public final PhraseSuggester.Builder forceUnigrams(@Nullable
                                                   java.lang.Boolean value)

API name: force_unigrams

gramSize

public final PhraseSuggester.Builder gramSize(@Nullable
                                              java.lang.Integer value)

API name: gram_size

highlight

public final PhraseSuggester.Builder highlight(@Nullable
                                               PhraseSuggestHighlight value)

API name: highlight

highlight

public final PhraseSuggester.Builder highlight(java.util.function.Function<PhraseSuggestHighlight.Builder,ObjectBuilder<PhraseSuggestHighlight>> fn)

API name: highlight

maxErrors

public final PhraseSuggester.Builder maxErrors(@Nullable
                                               java.lang.Double value)

API name: max_errors

realWordErrorLikelihood

public final PhraseSuggester.Builder realWordErrorLikelihood(@Nullable
                                                             java.lang.Double value)

API name: real_word_error_likelihood

separator

public final PhraseSuggester.Builder separator(@Nullable
                                               java.lang.String value)

API name: separator

shardSize

public final PhraseSuggester.Builder shardSize(@Nullable
                                               java.lang.Integer value)

API name: shard_size

smoothing

public final PhraseSuggester.Builder smoothing(@Nullable
                                               SmoothingModel value)

API name: smoothing

smoothing

public final PhraseSuggester.Builder smoothing(java.util.function.Function<SmoothingModel.Builder,ObjectBuilder<SmoothingModel>> fn)

API name: smoothing

text

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

API name: text

tokenLimit

public final PhraseSuggester.Builder tokenLimit(@Nullable
                                                java.lang.Integer value)

API name: token_limit

self

protected PhraseSuggester.Builder self()

Specified by:

self in class SuggesterBase.AbstractBuilder<PhraseSuggester.Builder>

build

public PhraseSuggester build()

Builds a PhraseSuggester.

Specified by:

build in interface ObjectBuilder<PhraseSuggester>

Throws:

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