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

Class PatternReplaceTokenFilter.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>

co.elastic.clients.elasticsearch._types.analysis.TokenFilterBase.AbstractBuilder<PatternReplaceTokenFilter.Builder>

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

All Implemented Interfaces:

WithJson<PatternReplaceTokenFilter.Builder>, ObjectBuilder<PatternReplaceTokenFilter>

Enclosing class:

PatternReplaceTokenFilter

public static class PatternReplaceTokenFilter.Builder
extends TokenFilterBase.AbstractBuilder<PatternReplaceTokenFilter.Builder>
implements ObjectBuilder<PatternReplaceTokenFilter>

Builder for PatternReplaceTokenFilter.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final PatternReplaceTokenFilter.Builder	all(Boolean value)	If true, all substrings matching the pattern parameter’s regular expression are replaced.
PatternReplaceTokenFilter	build()	Builds a PatternReplaceTokenFilter.
final PatternReplaceTokenFilter.Builder	flags(String value)	API name: flags
final PatternReplaceTokenFilter.Builder	pattern(String value)	Required - Regular expression, written in Java’s regular expression syntax.
final PatternReplaceTokenFilter.Builder	replacement(String value)	Replacement substring.
protected PatternReplaceTokenFilter.Builder	self()

Methods inherited from class co.elastic.clients.elasticsearch._types.analysis.TokenFilterBase.AbstractBuilder

version

Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase

withJson

Methods inherited from class co.elastic.clients.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

Methods inherited from interface co.elastic.clients.json.WithJson

withJson, withJson

Constructor Details

Builder

public Builder()

Method Details

all

public final PatternReplaceTokenFilter.Builder all(@Nullable
 Boolean value)

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

public final PatternReplaceTokenFilter.Builder flags(@Nullable
 String value)

API name: flags

pattern

public final PatternReplaceTokenFilter.Builder pattern(String value)

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

public final PatternReplaceTokenFilter.Builder replacement(@Nullable
 String value)

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

API name: replacement

self

protected PatternReplaceTokenFilter.Builder self()

Specified by:

self in class TokenFilterBase.AbstractBuilder<PatternReplaceTokenFilter.Builder>

build

public PatternReplaceTokenFilter build()

Builds a PatternReplaceTokenFilter.

Specified by:

build in interface ObjectBuilder<PatternReplaceTokenFilter>

Throws:

NullPointerException - if some of the required fields are null.