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

Class TermSuggester

java.lang.Object

org.opensearch.client.opensearch.core.search.SuggesterBase

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

All Implemented Interfaces:

JsonpSerializable, FieldSuggesterVariant

@JsonpDeserializable
public class TermSuggester
extends SuggesterBase
implements FieldSuggesterVariant

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TermSuggester.Builder	Builder for TermSuggester.

Nested classes/interfaces inherited from class org.opensearch.client.opensearch.core.search.SuggesterBase

SuggesterBase.AbstractBuilder<BuilderT extends SuggesterBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static JsonpDeserializer<TermSuggester>	_DESERIALIZER	Json deserializer for TermSuggester

Method Summary

Modifier and Type	Method	Description
FieldSuggester.Kind	_fieldSuggesterKind()	FieldSuggester variant kind.
java.lang.Boolean	lowercaseTerms()	API name: lowercase_terms
java.lang.Integer	maxEdits()	API name: max_edits
java.lang.Integer	maxInspections()	API name: max_inspections
java.lang.Float	maxTermFreq()	API name: max_term_freq
java.lang.Float	minDocFreq()	API name: min_doc_freq
java.lang.Integer	minWordLength()	API name: min_word_length
static TermSuggester	of(java.util.function.Function<TermSuggester.Builder,ObjectBuilder<TermSuggester>> fn)
java.lang.Integer	prefixLength()	API name: prefix_length
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupTermSuggesterDeserializer(ObjectDeserializer<TermSuggester.Builder> op)
java.lang.Integer	shardSize()	API name: shard_size
SuggestSort	sort()	API name: sort
StringDistance	stringDistance()	API name: string_distance
SuggestMode	suggestMode()	API name: suggest_mode
java.lang.String	text()	API name: text

Methods inherited from class org.opensearch.client.opensearch.core.search.SuggesterBase

analyzer, field, serialize, setupSuggesterBaseDeserializer, size

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.opensearch.core.search.FieldSuggesterVariant

_toFieldSuggester

Field Detail

_DESERIALIZER

public static final JsonpDeserializer<TermSuggester> _DESERIALIZER

Json deserializer for TermSuggester

Method Detail

of

public static TermSuggester of(java.util.function.Function<TermSuggester.Builder,ObjectBuilder<TermSuggester>> fn)

_fieldSuggesterKind

public FieldSuggester.Kind _fieldSuggesterKind()

FieldSuggester variant kind.

Specified by:

_fieldSuggesterKind in interface FieldSuggesterVariant

lowercaseTerms

@Nullable
public final java.lang.Boolean lowercaseTerms()

API name: lowercase_terms

maxEdits

@Nullable
public final java.lang.Integer maxEdits()

API name: max_edits

maxInspections

@Nullable
public final java.lang.Integer maxInspections()

API name: max_inspections

maxTermFreq

@Nullable
public final java.lang.Float maxTermFreq()

API name: max_term_freq

minDocFreq

@Nullable
public final java.lang.Float minDocFreq()

API name: min_doc_freq

minWordLength

@Nullable
public final java.lang.Integer minWordLength()

API name: min_word_length

prefixLength

@Nullable
public final java.lang.Integer prefixLength()

API name: prefix_length

shardSize

@Nullable
public final java.lang.Integer shardSize()

API name: shard_size

sort

@Nullable
public final SuggestSort sort()

API name: sort

stringDistance

@Nullable
public final StringDistance stringDistance()

API name: string_distance

suggestMode

@Nullable
public final SuggestMode suggestMode()

API name: suggest_mode

text

@Nullable
public final java.lang.String text()

API name: text

serializeInternal

protected void serializeInternal(jakarta.json.stream.JsonGenerator generator,
                                 JsonpMapper mapper)

Overrides:

serializeInternal in class SuggesterBase

setupTermSuggesterDeserializer

protected static void setupTermSuggesterDeserializer(ObjectDeserializer<TermSuggester.Builder> op)