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

Class KeepWordsTokenFilter

java.lang.Object

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

co.elastic.clients.elasticsearch._types.analysis.KeepWordsTokenFilter

All Implemented Interfaces:

TokenFilterDefinitionVariant, JsonpSerializable

@JsonpDeserializable
public class KeepWordsTokenFilter
extends TokenFilterBase
implements TokenFilterDefinitionVariant

See Also:

• API specification

Nested Class Summary

Nested Classes

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

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<KeepWordsTokenFilter>	_DESERIALIZER	Json deserializer for KeepWordsTokenFilter

Method Summary

Modifier and Type	Method	Description
TokenFilterDefinition.Kind	_tokenFilterDefinitionKind()	TokenFilterDefinition variant kind.
final List<String>	keepWords()	List of words to keep.
final Boolean	keepWordsCase()	If true, lowercase all keep words.
final String	keepWordsPath()	Path to a file that contains a list of words to keep.
static KeepWordsTokenFilter	of(Function<KeepWordsTokenFilter.Builder,ObjectBuilder<KeepWordsTokenFilter>> fn)
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupKeepWordsTokenFilterDeserializer(ObjectDeserializer<KeepWordsTokenFilter.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<KeepWordsTokenFilter> _DESERIALIZER

Json deserializer for KeepWordsTokenFilter

Method Details

of

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

_tokenFilterDefinitionKind

public TokenFilterDefinition.Kind _tokenFilterDefinitionKind()

TokenFilterDefinition variant kind.

Specified by:

_tokenFilterDefinitionKind in interface TokenFilterDefinitionVariant

keepWords

public final List<String> keepWords()

List of words to keep. Only tokens that match words in this list are included in the output. Either this parameter or keep_words_path must be specified.

API name: keep_words

keepWordsCase

@Nullable
public final Boolean keepWordsCase()

If true, lowercase all keep words. Defaults to false.

API name: keep_words_case

keepWordsPath

@Nullable
public final String keepWordsPath()

Path to a file that contains a list of words to keep. Only tokens that match words in this list are included in the output. This path must be absolute or relative to the config location, and the file must be UTF-8 encoded. Each word in the file must be separated by a line break. Either this parameter or keep_words must be specified.

API name: keep_words_path

serializeInternal

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

Overrides:

serializeInternal in class TokenFilterBase

setupKeepWordsTokenFilterDeserializer

protected static void setupKeepWordsTokenFilterDeserializer(ObjectDeserializer<KeepWordsTokenFilter.Builder> op)