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

Class TokenizerDefinition

java.lang.Object

org.opensearch.client.opensearch._types.analysis.TokenizerDefinition

All Implemented Interfaces:

JsonpSerializable, PlainJsonSerializable, TaggedUnion<TokenizerDefinition.Kind,TokenizerDefinitionVariant>

@JsonpDeserializable
@Generated("org.opensearch.client.codegen.CodeGenerator")
public class TokenizerDefinition
extends Object
implements TaggedUnion<TokenizerDefinition.Kind,TokenizerDefinitionVariant>, PlainJsonSerializable

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TokenizerDefinition.Builder
static enum	TokenizerDefinition.Kind	TokenizerDefinition variant kinds.

Field Summary

Fields

Modifier and Type	Field	Description
static final JsonpDeserializer<TokenizerDefinition>	_DESERIALIZER

Constructor Summary

Constructors

Constructor	Description
TokenizerDefinition(TokenizerDefinitionVariant value)

Method Summary

Modifier and Type	Method	Description
final TokenizerDefinitionVariant	_get()
final TokenizerDefinition.Kind	_kind()	Get the of the kind of variant held by this object.
static TokenizerDefinition.Builder	builder()
CharGroupTokenizer	charGroup()	Get the char_group variant value.
EdgeNGramTokenizer	edgeNgram()	Get the edge_ngram variant value.
boolean	equals(Object o)
int	hashCode()
IcuTokenizer	icuTokenizer()	Get the icu_tokenizer variant value.
boolean	isCharGroup()	Is this variant instance of kind char_group?
boolean	isEdgeNgram()	Is this variant instance of kind edge_ngram?
boolean	isIcuTokenizer()	Is this variant instance of kind icu_tokenizer?
boolean	isKeyword()	Is this variant instance of kind keyword?
boolean	isKuromojiTokenizer()	Is this variant instance of kind kuromoji_tokenizer?
boolean	isLetter()	Is this variant instance of kind letter?
boolean	isLowercase()	Is this variant instance of kind lowercase?
boolean	isNgram()	Is this variant instance of kind ngram?
boolean	isNoriTokenizer()	Is this variant instance of kind nori_tokenizer?
boolean	isPathHierarchy()	Is this variant instance of kind path_hierarchy?
boolean	isPattern()	Is this variant instance of kind pattern?
boolean	isSimplePattern()	Is this variant instance of kind simple_pattern?
boolean	isSimplePatternSplit()	Is this variant instance of kind simple_pattern_split?
boolean	isSmartcnTokenizer()	Is this variant instance of kind smartcn_tokenizer?
boolean	isStandard()	Is this variant instance of kind standard?
boolean	isUaxUrlEmail()	Is this variant instance of kind uax_url_email?
boolean	isWhitespace()	Is this variant instance of kind whitespace?
KeywordTokenizer	keyword()	Get the keyword variant value.
KuromojiTokenizer	kuromojiTokenizer()	Get the kuromoji_tokenizer variant value.
LetterTokenizer	letter()	Get the letter variant value.
LowercaseTokenizer	lowercase()	Get the lowercase variant value.
NGramTokenizer	ngram()	Get the ngram variant value.
NoriTokenizer	noriTokenizer()	Get the nori_tokenizer variant value.
static TokenizerDefinition	of(Function<TokenizerDefinition.Builder,ObjectBuilder<TokenizerDefinition>> fn)
PathHierarchyTokenizer	pathHierarchy()	Get the path_hierarchy variant value.
PatternTokenizer	pattern()	Get the pattern variant value.
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupTokenizerDefinitionDeserializer(ObjectDeserializer<TokenizerDefinition.Builder> op)
SimplePatternTokenizer	simplePattern()	Get the simple_pattern variant value.
SimplePatternSplitTokenizer	simplePatternSplit()	Get the simple_pattern_split variant value.
SmartcnTokenizer	smartcnTokenizer()	Get the smartcn_tokenizer variant value.
StandardTokenizer	standard()	Get the standard variant value.
TokenizerDefinition.Builder	toBuilder()
UaxEmailUrlTokenizer	uaxUrlEmail()	Get the uax_url_email variant value.
WhitespaceTokenizer	whitespace()	Get the whitespace variant value.

Methods inherited from class java.lang.Object

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

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

toJsonString

Field Details

_DESERIALIZER

public static final JsonpDeserializer<TokenizerDefinition> _DESERIALIZER

Constructor Details

TokenizerDefinition

public TokenizerDefinition(TokenizerDefinitionVariant value)

Method Details

_kind

public final TokenizerDefinition.Kind _kind()

Description copied from interface: TaggedUnion

Get the of the kind of variant held by this object.

Specified by:

_kind in interface TaggedUnion<TokenizerDefinition.Kind,TokenizerDefinitionVariant>

Returns:

the variant kind

_get

public final TokenizerDefinitionVariant _get()

Specified by:

_get in interface TaggedUnion<TokenizerDefinition.Kind,TokenizerDefinitionVariant>

of

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

isCharGroup

public boolean isCharGroup()

Is this variant instance of kind char_group?

charGroup

public CharGroupTokenizer charGroup()

Get the char_group variant value.

Throws:

IllegalStateException - if the current variant is not the char_group kind.

isEdgeNgram

public boolean isEdgeNgram()

Is this variant instance of kind edge_ngram?

edgeNgram

public EdgeNGramTokenizer edgeNgram()

Get the edge_ngram variant value.

Throws:

IllegalStateException - if the current variant is not the edge_ngram kind.

isIcuTokenizer

public boolean isIcuTokenizer()

Is this variant instance of kind icu_tokenizer?

icuTokenizer

public IcuTokenizer icuTokenizer()

Get the icu_tokenizer variant value.

Throws:

IllegalStateException - if the current variant is not the icu_tokenizer kind.

isKeyword

public boolean isKeyword()

Is this variant instance of kind keyword?

keyword

public KeywordTokenizer keyword()

Get the keyword variant value.

Throws:

IllegalStateException - if the current variant is not the keyword kind.

isKuromojiTokenizer

public boolean isKuromojiTokenizer()

Is this variant instance of kind kuromoji_tokenizer?

kuromojiTokenizer

public KuromojiTokenizer kuromojiTokenizer()

Get the kuromoji_tokenizer variant value.

Throws:

IllegalStateException - if the current variant is not the kuromoji_tokenizer kind.

isLetter

public boolean isLetter()

Is this variant instance of kind letter?

letter

public LetterTokenizer letter()

Get the letter variant value.

Throws:

IllegalStateException - if the current variant is not the letter kind.

isLowercase

public boolean isLowercase()

Is this variant instance of kind lowercase?

lowercase

public LowercaseTokenizer lowercase()

Get the lowercase variant value.

Throws:

IllegalStateException - if the current variant is not the lowercase kind.

isNgram

public boolean isNgram()

Is this variant instance of kind ngram?

ngram

public NGramTokenizer ngram()

Get the ngram variant value.

Throws:

IllegalStateException - if the current variant is not the ngram kind.

isNoriTokenizer

public boolean isNoriTokenizer()

Is this variant instance of kind nori_tokenizer?

noriTokenizer

public NoriTokenizer noriTokenizer()

Get the nori_tokenizer variant value.

Throws:

IllegalStateException - if the current variant is not the nori_tokenizer kind.

isPathHierarchy

public boolean isPathHierarchy()

Is this variant instance of kind path_hierarchy?

pathHierarchy

public PathHierarchyTokenizer pathHierarchy()

Get the path_hierarchy variant value.

Throws:

IllegalStateException - if the current variant is not the path_hierarchy kind.

isPattern

public boolean isPattern()

Is this variant instance of kind pattern?

pattern

public PatternTokenizer pattern()

Get the pattern variant value.

Throws:

IllegalStateException - if the current variant is not the pattern kind.

isSimplePattern

public boolean isSimplePattern()

Is this variant instance of kind simple_pattern?

simplePattern

public SimplePatternTokenizer simplePattern()

Get the simple_pattern variant value.

Throws:

IllegalStateException - if the current variant is not the simple_pattern kind.

isSimplePatternSplit

public boolean isSimplePatternSplit()

Is this variant instance of kind simple_pattern_split?

simplePatternSplit

public SimplePatternSplitTokenizer simplePatternSplit()

Get the simple_pattern_split variant value.

Throws:

IllegalStateException - if the current variant is not the simple_pattern_split kind.

isSmartcnTokenizer

public boolean isSmartcnTokenizer()

Is this variant instance of kind smartcn_tokenizer?

smartcnTokenizer

public SmartcnTokenizer smartcnTokenizer()

Get the smartcn_tokenizer variant value.

Throws:

IllegalStateException - if the current variant is not the smartcn_tokenizer kind.

isStandard

public boolean isStandard()

Is this variant instance of kind standard?

standard

public StandardTokenizer standard()

Get the standard variant value.

Throws:

IllegalStateException - if the current variant is not the standard kind.

isUaxUrlEmail

public boolean isUaxUrlEmail()

Is this variant instance of kind uax_url_email?

uaxUrlEmail

public UaxEmailUrlTokenizer uaxUrlEmail()

Get the uax_url_email variant value.

Throws:

IllegalStateException - if the current variant is not the uax_url_email kind.

isWhitespace

public boolean isWhitespace()

Is this variant instance of kind whitespace?

whitespace

public WhitespaceTokenizer whitespace()

Get the whitespace variant value.

Throws:

IllegalStateException - if the current variant is not the whitespace kind.

serialize

public void serialize(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

Specified by:

serialize in interface JsonpSerializable

toBuilder

@Nonnull
public TokenizerDefinition.Builder toBuilder()

builder

@Nonnull
public static TokenizerDefinition.Builder builder()

setupTokenizerDefinitionDeserializer

protected static void setupTokenizerDefinitionDeserializer(ObjectDeserializer<TokenizerDefinition.Builder> op)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object