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

Class StopTokenFilter

java.lang.Object

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

co.elastic.clients.elasticsearch._types.analysis.StopTokenFilter

All Implemented Interfaces:

TokenFilterDefinitionVariant, JsonpSerializable

@JsonpDeserializable
public class StopTokenFilter
extends TokenFilterBase
implements TokenFilterDefinitionVariant

See Also:

• API specification

Nested Class Summary

Nested Classes

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

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

Method Summary

Modifier and Type	Method	Description
TokenFilterDefinition.Kind	_tokenFilterDefinitionKind()	TokenFilterDefinition variant kind.
final Boolean	ignoreCase()	If true, stop word matching is case insensitive.
static StopTokenFilter	of(Function<StopTokenFilter.Builder,ObjectBuilder<StopTokenFilter>> fn)
final Boolean	removeTrailing()	If true, the last token of a stream is removed if it’s a stop word.
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupStopTokenFilterDeserializer(ObjectDeserializer<StopTokenFilter.Builder> op)
final List<String>	stopwords()	Language value, such as _arabic_ or _thai_.
final String	stopwordsPath()	Path to a file that contains a list of stop words to remove.

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<StopTokenFilter> _DESERIALIZER

Json deserializer for StopTokenFilter

Method Details

of

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

_tokenFilterDefinitionKind

public TokenFilterDefinition.Kind _tokenFilterDefinitionKind()

TokenFilterDefinition variant kind.

Specified by:

_tokenFilterDefinitionKind in interface TokenFilterDefinitionVariant

ignoreCase

@Nullable
public final Boolean ignoreCase()

If true, stop word matching is case insensitive. For example, if true, a stop word of the matches and removes The, THE, or the. Defaults to false.

API name: ignore_case

removeTrailing

@Nullable
public final Boolean removeTrailing()

If true, the last token of a stream is removed if it’s a stop word. Defaults to true.

API name: remove_trailing

stopwords

public final List<String> stopwords()

Language value, such as _arabic_ or _thai_. Defaults to _english_.

API name: stopwords

stopwordsPath

@Nullable
public final String stopwordsPath()

Path to a file that contains a list of stop words to remove. This path must be absolute or relative to the config location, and the file must be UTF-8 encoded. Each stop word in the file must be separated by a line break.

API name: stopwords_path

serializeInternal

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

Overrides:

serializeInternal in class TokenFilterBase

setupStopTokenFilterDeserializer

protected static void setupStopTokenFilterDeserializer(ObjectDeserializer<StopTokenFilter.Builder> op)