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:

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

Enclosing class:

TermSuggester

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

Builder for TermSuggester.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
TermSuggester	build()	Builds a TermSuggester.
TermSuggester.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final TermSuggester.Builder	lowercaseTerms(Boolean value)	API name: lowercase_terms
final TermSuggester.Builder	maxEdits(Integer value)	API name: max_edits
final TermSuggester.Builder	maxInspections(Integer value)	API name: max_inspections
final TermSuggester.Builder	maxTermFreq(Float value)	API name: max_term_freq
final TermSuggester.Builder	minDocFreq(Float value)	API name: min_doc_freq
final TermSuggester.Builder	minWordLength(Integer value)	API name: min_word_length
final TermSuggester.Builder	prefixLength(Integer value)	API name: prefix_length
protected TermSuggester.Builder	self()
final TermSuggester.Builder	shardSize(Integer value)	API name: shard_size
final TermSuggester.Builder	sort(SuggestSort value)	API name: sort
final TermSuggester.Builder	stringDistance(StringDistance value)	API name: string_distance
final TermSuggester.Builder	suggestMode(SuggestMode value)	API name: suggest_mode
final TermSuggester.Builder	text(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, _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 TermSuggester.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<TermSuggester.Builder,TermSuggester>

Returns:

a new builder instance.

self

@Nonnull
protected TermSuggester.Builder self()

Specified by:

self in class SuggesterBase.AbstractBuilder<TermSuggester.Builder>

lowercaseTerms

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

API name: lowercase_terms

maxEdits

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

API name: max_edits

maxInspections

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

API name: max_inspections

maxTermFreq

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

API name: max_term_freq

minDocFreq

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

API name: min_doc_freq

minWordLength

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

API name: min_word_length

prefixLength

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

API name: prefix_length

shardSize

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

API name: shard_size

sort

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

API name: sort

stringDistance

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

API name: string_distance

suggestMode

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

API name: suggest_mode

text

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

API name: text

build

@Nonnull
public TermSuggester build()

Builds a TermSuggester.

Specified by:

build in interface ObjectBuilder<TermSuggester>

Throws:

NullPointerException - if some of the required fields are null.