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

Class PatternReplaceTokenFilter

java.lang.Object

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

co.elastic.clients.elasticsearch._types.analysis.PatternReplaceTokenFilter

All Implemented Interfaces:

TokenFilterDefinitionVariant, JsonpSerializable

@JsonpDeserializable
public class PatternReplaceTokenFilter
extends TokenFilterBase
implements TokenFilterDefinitionVariant

See Also:

• API specification

Nested Class Summary

Nested Classes

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

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

Method Summary

Modifier and Type	Method	Description
TokenFilterDefinition.Kind	_tokenFilterDefinitionKind()	TokenFilterDefinition variant kind.
final Boolean	all()	If true, all substrings matching the pattern parameter’s regular expression are replaced.
final String	flags()	API name: flags
static PatternReplaceTokenFilter	of(Function<PatternReplaceTokenFilter.Builder,ObjectBuilder<PatternReplaceTokenFilter>> fn)
final String	pattern()	Required - Regular expression, written in Java’s regular expression syntax.
final String	replacement()	Replacement substring.
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupPatternReplaceTokenFilterDeserializer(ObjectDeserializer<PatternReplaceTokenFilter.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<PatternReplaceTokenFilter> _DESERIALIZER

Json deserializer for PatternReplaceTokenFilter

Method Details

of

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

_tokenFilterDefinitionKind

public TokenFilterDefinition.Kind _tokenFilterDefinitionKind()

TokenFilterDefinition variant kind.

Specified by:

_tokenFilterDefinitionKind in interface TokenFilterDefinitionVariant

all

@Nullable
public final Boolean all()

If true, all substrings matching the pattern parameter’s regular expression are replaced. If false, the filter replaces only the first matching substring in each token. Defaults to true.

API name: all

flags

@Nullable
public final String flags()

API name: flags

pattern

public final String pattern()

Required - Regular expression, written in Java’s regular expression syntax. The filter replaces token substrings matching this pattern with the substring in the replacement parameter.

API name: pattern

replacement

@Nullable
public final String replacement()

Replacement substring. Defaults to an empty substring ("").

API name: replacement

serializeInternal

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

Overrides:

serializeInternal in class TokenFilterBase

setupPatternReplaceTokenFilterDeserializer

protected static void setupPatternReplaceTokenFilterDeserializer(ObjectDeserializer<PatternReplaceTokenFilter.Builder> op)