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

Class TermSuggester.Builder

java.lang.Object

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

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

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
TermSuggester	build()	Builds a TermSuggester.
TermSuggester.Builder	lowercaseTerms(java.lang.Boolean value)	API name: lowercase_terms
TermSuggester.Builder	maxEdits(java.lang.Number value)	API name: max_edits
TermSuggester.Builder	maxInspections(java.lang.Number value)	API name: max_inspections
TermSuggester.Builder	maxTermFreq(java.lang.Number value)	API name: max_term_freq
TermSuggester.Builder	minDocFreq(java.lang.Number value)	API name: min_doc_freq
TermSuggester.Builder	minWordLength(java.lang.Number value)	API name: min_word_length
TermSuggester.Builder	prefixLength(java.lang.Number value)	API name: prefix_length
protected TermSuggester.Builder	self()
TermSuggester.Builder	shardSize(java.lang.Number value)	API name: shard_size
TermSuggester.Builder	sort(jakarta.json.JsonValue value)	API name: sort
TermSuggester.Builder	stringDistance(jakarta.json.JsonValue value)	API name: string_distance
TermSuggester.Builder	suggestMode(jakarta.json.JsonValue value)	API name: suggest_mode
TermSuggester.Builder	text(java.lang.String value)	API name: text

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

lowercaseTerms

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

API name: lowercase_terms

maxEdits

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

API name: max_edits

maxInspections

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

API name: max_inspections

maxTermFreq

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

API name: max_term_freq

minDocFreq

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

API name: min_doc_freq

minWordLength

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

API name: min_word_length

prefixLength

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

API name: prefix_length

shardSize

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

API name: shard_size

sort

public TermSuggester.Builder sort(@Nullable jakarta.json.JsonValue value)

API name: sort

stringDistance

public TermSuggester.Builder stringDistance(@Nullable jakarta.json.JsonValue value)

API name: string_distance

suggestMode

public TermSuggester.Builder suggestMode(@Nullable jakarta.json.JsonValue value)

API name: suggest_mode

text

public 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.