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

Class KeywordMarkerTokenFilter

java.lang.Object

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

co.elastic.clients.elasticsearch._types.analysis.KeywordMarkerTokenFilter

All Implemented Interfaces:

TokenFilterDefinitionVariant, JsonpSerializable

@JsonpDeserializable
public class KeywordMarkerTokenFilter
extends TokenFilterBase
implements TokenFilterDefinitionVariant

See Also:

• API specification

Nested Class Summary

Nested Classes

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

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

Method Summary

Modifier and Type	Method	Description
TokenFilterDefinition.Kind	_tokenFilterDefinitionKind()	TokenFilterDefinition variant kind.
final Boolean	ignoreCase()	If true, matching for the keywords and keywords_path parameters ignores letter case.
final List<String>	keywords()	Array of keywords.
final String	keywordsPath()	Path to a file that contains a list of keywords.
final String	keywordsPattern()	Java regular expression used to match tokens.
static KeywordMarkerTokenFilter	of(Function<KeywordMarkerTokenFilter.Builder,ObjectBuilder<KeywordMarkerTokenFilter>> fn)
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupKeywordMarkerTokenFilterDeserializer(ObjectDeserializer<KeywordMarkerTokenFilter.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<KeywordMarkerTokenFilter> _DESERIALIZER

Json deserializer for KeywordMarkerTokenFilter

Method Details

of

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

_tokenFilterDefinitionKind

public TokenFilterDefinition.Kind _tokenFilterDefinitionKind()

TokenFilterDefinition variant kind.

Specified by:

_tokenFilterDefinitionKind in interface TokenFilterDefinitionVariant

ignoreCase

@Nullable
public final Boolean ignoreCase()

If true, matching for the keywords and keywords_path parameters ignores letter case. Defaults to false.

API name: ignore_case

keywords

public final List<String> keywords()

Array of keywords. Tokens that match these keywords are not stemmed. This parameter, keywords_path, or keywords_pattern must be specified. You cannot specify this parameter and keywords_pattern.

API name: keywords

keywordsPath

@Nullable
public final String keywordsPath()

Path to a file that contains a list of keywords. Tokens that match these keywords are not stemmed. 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. This parameter, keywords, or keywords_pattern must be specified. You cannot specify this parameter and keywords_pattern.

API name: keywords_path

keywordsPattern

@Nullable
public final String keywordsPattern()

Java regular expression used to match tokens. Tokens that match this expression are marked as keywords and not stemmed. This parameter, keywords, or keywords_path must be specified. You cannot specify this parameter and keywords or keywords_pattern.

API name: keywords_pattern

serializeInternal

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

Overrides:

serializeInternal in class TokenFilterBase

setupKeywordMarkerTokenFilterDeserializer

protected static void setupKeywordMarkerTokenFilterDeserializer(ObjectDeserializer<KeywordMarkerTokenFilter.Builder> op)