Package co.elastic.clients.elasticsearch._types.analysis

Class NGramTokenFilter

java.lang.Object

co.elastic.clients.elasticsearch._types.analysis.TokenFilterBase

co.elastic.clients.elasticsearch._types.analysis.NGramTokenFilter

All Implemented Interfaces:

TokenFilterDefinitionVariant, JsonpSerializable

@JsonpDeserializable
public class NGramTokenFilter
extends TokenFilterBase
implements TokenFilterDefinitionVariant

See Also:

• API specification

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.analysis.TokenFilterBase

TokenFilterBase.AbstractBuilder<BuilderT extends TokenFilterBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
TokenFilterDefinition.Kind	_tokenFilterDefinitionKind()	TokenFilterDefinition variant kind.
final Integer	maxGram()	Maximum length of characters in a gram.
final Integer	minGram()	Minimum length of characters in a gram.
static NGramTokenFilter	of(Function<NGramTokenFilter.Builder,ObjectBuilder<NGramTokenFilter>> fn)
final Boolean	preserveOriginal()	Emits original token when set to true.
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupNGramTokenFilterDeserializer(ObjectDeserializer<NGramTokenFilter.Builder> op)

Methods inherited from class co.elastic.clients.elasticsearch._types.analysis.TokenFilterBase

serialize, setupTokenFilterBaseDeserializer, toString, version

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface co.elastic.clients.json.JsonpSerializable

serialize

Methods inherited from interface co.elastic.clients.elasticsearch._types.analysis.TokenFilterDefinitionVariant

_toTokenFilterDefinition

Field Details

_DESERIALIZER

public static final JsonpDeserializer<NGramTokenFilter> _DESERIALIZER

Json deserializer for NGramTokenFilter

Method Details

of

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

_tokenFilterDefinitionKind

public TokenFilterDefinition.Kind _tokenFilterDefinitionKind()

TokenFilterDefinition variant kind.

Specified by:

_tokenFilterDefinitionKind in interface TokenFilterDefinitionVariant

maxGram

@Nullable
public final Integer maxGram()

Maximum length of characters in a gram. Defaults to 2.

API name: max_gram

minGram

@Nullable
public final Integer minGram()

Minimum length of characters in a gram. Defaults to 1.

API name: min_gram

preserveOriginal

@Nullable
public final Boolean preserveOriginal()

Emits original token when set to true. Defaults to false.

API name: preserve_original

serializeInternal

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

Overrides:

serializeInternal in class TokenFilterBase

setupNGramTokenFilterDeserializer

protected static void setupNGramTokenFilterDeserializer(ObjectDeserializer<NGramTokenFilter.Builder> op)