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:

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

Enclosing class:

PhraseSuggester

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

Builder for PhraseSuggester.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
PhraseSuggester	build()	Builds a PhraseSuggester.
final PhraseSuggester.Builder	collate(Function<PhraseSuggestCollate.Builder,ObjectBuilder<PhraseSuggestCollate>> fn)	API name: collate
final PhraseSuggester.Builder	collate(PhraseSuggestCollate value)	API name: collate
final PhraseSuggester.Builder	confidence(Double value)	API name: confidence
PhraseSuggester.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final PhraseSuggester.Builder	directGenerator(Function<DirectGenerator.Builder,ObjectBuilder<DirectGenerator>> fn)	API name: direct_generator
final PhraseSuggester.Builder	directGenerator(List<DirectGenerator> list)	API name: direct_generator
final PhraseSuggester.Builder	directGenerator(DirectGenerator value, DirectGenerator... values)	API name: direct_generator
final PhraseSuggester.Builder	forceUnigrams(Boolean value)	API name: force_unigrams
final PhraseSuggester.Builder	gramSize(Integer value)	API name: gram_size
final PhraseSuggester.Builder	highlight(Function<PhraseSuggestHighlight.Builder,ObjectBuilder<PhraseSuggestHighlight>> fn)	API name: highlight
final PhraseSuggester.Builder	highlight(PhraseSuggestHighlight value)	API name: highlight
final PhraseSuggester.Builder	maxErrors(Double value)	API name: max_errors
final PhraseSuggester.Builder	realWordErrorLikelihood(Double value)	API name: real_word_error_likelihood
protected PhraseSuggester.Builder	self()
final PhraseSuggester.Builder	separator(String value)	API name: separator
final PhraseSuggester.Builder	shardSize(Integer value)	API name: shard_size
final PhraseSuggester.Builder	smoothing(Function<SmoothingModel.Builder,ObjectBuilder<SmoothingModel>> fn)	API name: smoothing
final PhraseSuggester.Builder	smoothing(SmoothingModel value)	API name: smoothing
final PhraseSuggester.Builder	text(String value)	API name: text
final PhraseSuggester.Builder	tokenLimit(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, _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 PhraseSuggester.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<PhraseSuggester.Builder,PhraseSuggester>

Returns:

a new builder instance.

self

@Nonnull
protected PhraseSuggester.Builder self()

Specified by:

self in class SuggesterBase.AbstractBuilder<PhraseSuggester.Builder>

collate

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

API name: collate

collate

@Nonnull
public final PhraseSuggester.Builder collate(Function<PhraseSuggestCollate.Builder,ObjectBuilder<PhraseSuggestCollate>> fn)

API name: collate

confidence

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

API name: confidence

directGenerator

@Nonnull
public final PhraseSuggester.Builder directGenerator(List<DirectGenerator> list)

API name: direct_generator

Adds all elements of list to directGenerator.

directGenerator

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

API name: direct_generator

Adds one or more values to directGenerator.

directGenerator

@Nonnull
public final PhraseSuggester.Builder directGenerator(Function<DirectGenerator.Builder,ObjectBuilder<DirectGenerator>> fn)

API name: direct_generator

Adds a value to directGenerator using a builder lambda.

forceUnigrams

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

API name: force_unigrams

gramSize

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

API name: gram_size

highlight

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

API name: highlight

highlight

@Nonnull
public final PhraseSuggester.Builder highlight(Function<PhraseSuggestHighlight.Builder,ObjectBuilder<PhraseSuggestHighlight>> fn)

API name: highlight

maxErrors

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

API name: max_errors

realWordErrorLikelihood

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

API name: real_word_error_likelihood

separator

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

API name: separator

shardSize

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

API name: shard_size

smoothing

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

API name: smoothing

smoothing

@Nonnull
public final PhraseSuggester.Builder smoothing(Function<SmoothingModel.Builder,ObjectBuilder<SmoothingModel>> fn)

API name: smoothing

text

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

API name: text

tokenLimit

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

API name: token_limit

build

@Nonnull
public PhraseSuggester build()

Builds a PhraseSuggester.

Specified by:

build in interface ObjectBuilder<PhraseSuggester>

Throws:

NullPointerException - if some of the required fields are null.