Package org.opensearch.client.opensearch._types.analysis

Class NGramTokenizer

java.lang.Object

org.opensearch.client.opensearch._types.analysis.TokenizerBase

org.opensearch.client.opensearch._types.analysis.NGramTokenizer

All Implemented Interfaces:

JsonpSerializable, PlainJsonSerializable, TokenizerDefinitionVariant, ToCopyableBuilder<NGramTokenizer.Builder,NGramTokenizer>

@JsonpDeserializable
@Generated("org.opensearch.client.codegen.CodeGenerator")
public class NGramTokenizer
extends TokenizerBase
implements TokenizerDefinitionVariant, ToCopyableBuilder<NGramTokenizer.Builder,NGramTokenizer>

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class org.opensearch.client.opensearch._types.analysis.TokenizerBase

TokenizerBase.AbstractBuilder<BuilderT extends TokenizerBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
TokenizerDefinition.Kind	_tokenizerDefinitionKind()	TokenizerDefinition variant kind.
static NGramTokenizer.Builder	builder()
java.lang.String	customTokenChars()	API name: custom_token_chars
boolean	equals(java.lang.Object o)
int	hashCode()
int	maxGram()	Required - API name: max_gram
int	minGram()	Required - API name: min_gram
static NGramTokenizer	of(java.util.function.Function<NGramTokenizer.Builder,ObjectBuilder<NGramTokenizer>> fn)
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupNGramTokenizerDeserializer(ObjectDeserializer<NGramTokenizer.Builder> op)
NGramTokenizer.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.
java.util.List<TokenChar>	tokenChars()	Required - API name: token_chars

Methods inherited from class org.opensearch.client.opensearch._types.analysis.TokenizerBase

serialize, setupTokenizerBaseDeserializer, version

Methods inherited from class java.lang.Object

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

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

serialize

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

toJsonString

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

copy

Methods inherited from interface org.opensearch.client.opensearch._types.analysis.TokenizerDefinitionVariant

_toTokenizerDefinition

Field Detail

_DESERIALIZER

public static final JsonpDeserializer<NGramTokenizer> _DESERIALIZER

Json deserializer for NGramTokenizer

Method Detail

of

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

_tokenizerDefinitionKind

public TokenizerDefinition.Kind _tokenizerDefinitionKind()

TokenizerDefinition variant kind.

Specified by:

_tokenizerDefinitionKind in interface TokenizerDefinitionVariant

customTokenChars

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

API name: custom_token_chars

maxGram

public final int maxGram()

Required - API name: max_gram

minGram

public final int minGram()

Required - API name: min_gram

tokenChars

@Nonnull
public final java.util.List<TokenChar> tokenChars()

Required - API name: token_chars

serializeInternal

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

Overrides:

serializeInternal in class TokenizerBase

toBuilder

@Nonnull
public NGramTokenizer.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<NGramTokenizer.Builder,NGramTokenizer>

Returns:

a new builder instance.

builder

@Nonnull
public static NGramTokenizer.Builder builder()

setupNGramTokenizerDeserializer

protected static void setupNGramTokenizerDeserializer(ObjectDeserializer<NGramTokenizer.Builder> op)

hashCode

public int hashCode()

Overrides:

hashCode in class TokenizerBase

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class TokenizerBase