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, PlainJsonSerializable, FieldSuggesterVariant, ToCopyableBuilder<TermSuggester.Builder,TermSuggester>

@JsonpDeserializable
@Generated("org.opensearch.client.codegen.CodeGenerator")
public class TermSuggester
extends SuggesterBase
implements FieldSuggesterVariant, ToCopyableBuilder<TermSuggester.Builder,TermSuggester>

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 final JsonpDeserializer<TermSuggester>	_DESERIALIZER	Json deserializer for TermSuggester

Method Summary

Modifier and Type	Method	Description
FieldSuggester.Kind	_fieldSuggesterKind()	FieldSuggester variant kind.
static TermSuggester.Builder	builder()
boolean	equals(Object o)
int	hashCode()
final Boolean	lowercaseTerms()	API name: lowercase_terms
final Integer	maxEdits()	API name: max_edits
final Integer	maxInspections()	API name: max_inspections
final Float	maxTermFreq()	API name: max_term_freq
final Float	minDocFreq()	API name: min_doc_freq
final Integer	minWordLength()	API name: min_word_length
static TermSuggester	of(Function<TermSuggester.Builder,ObjectBuilder<TermSuggester>> fn)
final Integer	prefixLength()	API name: prefix_length
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupTermSuggesterDeserializer(ObjectDeserializer<TermSuggester.Builder> op)
final Integer	shardSize()	API name: shard_size
final SuggestSort	sort()	API name: sort
final StringDistance	stringDistance()	API name: string_distance
final SuggestMode	suggestMode()	API name: suggest_mode
final String	text()	API name: text
TermSuggester.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

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

analyzer, field, serialize, setupSuggesterBaseDeserializer, size

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.opensearch.client.opensearch.core.search.FieldSuggesterVariant

toFieldSuggester

Methods inherited from interface org.opensearch.client.json.PlainJsonSerializable

toJsonString

Methods inherited from interface org.opensearch.client.util.ToCopyableBuilder

copy

Field Details

_DESERIALIZER

public static final JsonpDeserializer<TermSuggester> _DESERIALIZER

Json deserializer for TermSuggester

Method Details

of

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

_fieldSuggesterKind

public FieldSuggester.Kind _fieldSuggesterKind()

FieldSuggester variant kind.

Specified by:

_fieldSuggesterKind in interface FieldSuggesterVariant

lowercaseTerms

@Nullable
public final Boolean lowercaseTerms()

API name: lowercase_terms

maxEdits

@Nullable
public final Integer maxEdits()

API name: max_edits

maxInspections

@Nullable
public final Integer maxInspections()

API name: max_inspections

maxTermFreq

@Nullable
public final Float maxTermFreq()

API name: max_term_freq

minDocFreq

@Nullable
public final Float minDocFreq()

API name: min_doc_freq

minWordLength

@Nullable
public final Integer minWordLength()

API name: min_word_length

prefixLength

@Nullable
public final Integer prefixLength()

API name: prefix_length

shardSize

@Nullable
public final 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 String text()

API name: text

serializeInternal

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

Overrides:

serializeInternal in class SuggesterBase

toBuilder

@Nonnull
public TermSuggester.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<TermSuggester.Builder,TermSuggester>

Returns:

a new builder instance.

builder

@Nonnull
public static TermSuggester.Builder builder()

setupTermSuggesterDeserializer

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

hashCode

public int hashCode()

Overrides:

hashCode in class SuggesterBase

equals

public boolean equals(Object o)

Overrides:

equals in class SuggesterBase