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

Class EdgeNGramTokenFilter.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

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

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

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

All Implemented Interfaces:

WithJson<EdgeNGramTokenFilter.Builder>, ObjectBuilder<EdgeNGramTokenFilter>

Enclosing class:

EdgeNGramTokenFilter

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

Builder for EdgeNGramTokenFilter.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
EdgeNGramTokenFilter	build()	Builds a EdgeNGramTokenFilter.
final EdgeNGramTokenFilter.Builder	maxGram(Integer value)	Maximum character length of a gram.
final EdgeNGramTokenFilter.Builder	minGram(Integer value)	Minimum character length of a gram.
final EdgeNGramTokenFilter.Builder	preserveOriginal(Boolean value)	Emits original token when set to true.
protected EdgeNGramTokenFilter.Builder	self()
final EdgeNGramTokenFilter.Builder	side(EdgeNGramSide value)	Indicates whether to truncate tokens from the front or back.

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

maxGram

public final EdgeNGramTokenFilter.Builder maxGram(@Nullable
 Integer value)

Maximum character length of a gram. For custom token filters, defaults to 2. For the built-in edge_ngram filter, defaults to 1.

API name: max_gram

minGram

public final EdgeNGramTokenFilter.Builder minGram(@Nullable
 Integer value)

Minimum character length of a gram. Defaults to 1.

API name: min_gram

side

public final EdgeNGramTokenFilter.Builder side(@Nullable
 EdgeNGramSide value)

Indicates whether to truncate tokens from the front or back. Defaults to front.

API name: side

preserveOriginal

public final EdgeNGramTokenFilter.Builder preserveOriginal(@Nullable
 Boolean value)

Emits original token when set to true. Defaults to false.

API name: preserve_original

self

protected EdgeNGramTokenFilter.Builder self()

Specified by:

self in class TokenFilterBase.AbstractBuilder<EdgeNGramTokenFilter.Builder>

build

public EdgeNGramTokenFilter build()

Builds a EdgeNGramTokenFilter.

Specified by:

build in interface ObjectBuilder<EdgeNGramTokenFilter>

Throws:

NullPointerException - if some of the required fields are null.