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

Class TermSuggester.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

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

org.opensearch.client.opensearch.core.search.TermSuggester.Builder

All Implemented Interfaces:

ObjectBuilder<TermSuggester>

Enclosing class:

TermSuggester

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

Builder for TermSuggester.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
TermSuggester	build()	Builds a TermSuggester.
TermSuggester.Builder	lowercaseTerms(java.lang.Boolean value)	API name: lowercase_terms
TermSuggester.Builder	maxEdits(java.lang.Integer value)	API name: max_edits
TermSuggester.Builder	maxInspections(java.lang.Integer value)	API name: max_inspections
TermSuggester.Builder	maxTermFreq(java.lang.Float value)	API name: max_term_freq
TermSuggester.Builder	minDocFreq(java.lang.Float value)	API name: min_doc_freq
TermSuggester.Builder	minWordLength(java.lang.Integer value)	API name: min_word_length
TermSuggester.Builder	prefixLength(java.lang.Integer value)	API name: prefix_length
protected TermSuggester.Builder	self()
TermSuggester.Builder	shardSize(java.lang.Integer value)	API name: shard_size
TermSuggester.Builder	sort(SuggestSort value)	API name: sort
TermSuggester.Builder	stringDistance(StringDistance value)	API name: string_distance
TermSuggester.Builder	suggestMode(SuggestMode value)	API name: suggest_mode
TermSuggester.Builder	text(java.lang.String value)	API name: text

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

lowercaseTerms

public final TermSuggester.Builder lowercaseTerms(@Nullable
                                                  java.lang.Boolean value)

API name: lowercase_terms

maxEdits

public final TermSuggester.Builder maxEdits(@Nullable
                                            java.lang.Integer value)

API name: max_edits

maxInspections

public final TermSuggester.Builder maxInspections(@Nullable
                                                  java.lang.Integer value)

API name: max_inspections

maxTermFreq

public final TermSuggester.Builder maxTermFreq(@Nullable
                                               java.lang.Float value)

API name: max_term_freq

minDocFreq

public final TermSuggester.Builder minDocFreq(@Nullable
                                              java.lang.Float value)

API name: min_doc_freq

minWordLength

public final TermSuggester.Builder minWordLength(@Nullable
                                                 java.lang.Integer value)

API name: min_word_length

prefixLength

public final TermSuggester.Builder prefixLength(@Nullable
                                                java.lang.Integer value)

API name: prefix_length

shardSize

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

API name: shard_size

sort

public final TermSuggester.Builder sort(@Nullable
                                        SuggestSort value)

API name: sort

stringDistance

public final TermSuggester.Builder stringDistance(@Nullable
                                                  StringDistance value)

API name: string_distance

suggestMode

public final TermSuggester.Builder suggestMode(@Nullable
                                               SuggestMode value)

API name: suggest_mode

text

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

API name: text

self

protected TermSuggester.Builder self()

Specified by:

self in class SuggesterBase.AbstractBuilder<TermSuggester.Builder>

build

public TermSuggester build()

Builds a TermSuggester.

Specified by:

build in interface ObjectBuilder<TermSuggester>

Throws:

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