Package org.opensearch.client.opensearch._global.search

Class PhraseSuggester.Builder

java.lang.Object

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

org.opensearch.client.opensearch._global.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.

Nested Class Summary

Nested classes/interfaces inherited from interface org.opensearch.client.util.ObjectBuilder

ObjectBuilder.Constant<V>

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
PhraseSuggester.Builder	addDirectGenerator(java.util.function.Function<DirectGenerator.Builder,ObjectBuilder<DirectGenerator>> fn)	Add a value to directGenerator(List), creating the list if needed.
PhraseSuggester.Builder	addDirectGenerator(DirectGenerator value)	Add a value to directGenerator(List), creating the list if needed.
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.Number value)	API name: confidence
PhraseSuggester.Builder	directGenerator(java.util.function.Function<DirectGenerator.Builder,ObjectBuilder<DirectGenerator>> fn)	Set directGenerator(List) to a singleton list.
PhraseSuggester.Builder	directGenerator(java.util.List<DirectGenerator> value)	API name: direct_generator
PhraseSuggester.Builder	directGenerator(DirectGenerator... value)	API name: direct_generator
PhraseSuggester.Builder	forceUnigrams(java.lang.Boolean value)	API name: force_unigrams
PhraseSuggester.Builder	gramSize(java.lang.Number 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.Number value)	API name: max_errors
PhraseSuggester.Builder	realWordErrorLikelihood(java.lang.Number 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.Number value)	API name: shard_size
PhraseSuggester.Builder	smoothing(java.util.function.Function<SmoothingModelContainer.Builder,ObjectBuilder<SmoothingModelContainer>> fn)	API name: smoothing
PhraseSuggester.Builder	smoothing(SmoothingModelContainer value)	API name: smoothing
PhraseSuggester.Builder	text(java.lang.String value)	API name: text
PhraseSuggester.Builder	tokenLimit(java.lang.Number value)	API name: token_limit

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

analyzer, field, size

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

collate

public PhraseSuggester.Builder collate(@Nullable PhraseSuggestCollate value)

API name: collate

collate

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

API name: collate

confidence

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

API name: confidence

directGenerator

public PhraseSuggester.Builder directGenerator(@Nullable java.util.List<DirectGenerator> value)

API name: direct_generator

directGenerator

public PhraseSuggester.Builder directGenerator(DirectGenerator... value)

API name: direct_generator

addDirectGenerator

public PhraseSuggester.Builder addDirectGenerator(DirectGenerator value)

Add a value to directGenerator(List), creating the list if needed.

directGenerator

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

Set directGenerator(List) to a singleton list.

addDirectGenerator

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

Add a value to directGenerator(List), creating the list if needed.

forceUnigrams

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

API name: force_unigrams

gramSize

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

API name: gram_size

highlight

public PhraseSuggester.Builder highlight(@Nullable PhraseSuggestHighlight value)

API name: highlight

highlight

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

API name: highlight

maxErrors

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

API name: max_errors

realWordErrorLikelihood

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

API name: real_word_error_likelihood

separator

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

API name: separator

shardSize

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

API name: shard_size

smoothing

public PhraseSuggester.Builder smoothing(@Nullable SmoothingModelContainer value)

API name: smoothing

smoothing

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

API name: smoothing

text

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

API name: text

tokenLimit

public PhraseSuggester.Builder tokenLimit(@Nullable java.lang.Number 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.