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

Class StopTokenFilter.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

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

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

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

All Implemented Interfaces:

WithJson<StopTokenFilter.Builder>, ObjectBuilder<StopTokenFilter>

Enclosing class:

StopTokenFilter

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

Builder for StopTokenFilter.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
StopTokenFilter	build()	Builds a StopTokenFilter.
final StopTokenFilter.Builder	ignoreCase(Boolean value)	If true, stop word matching is case insensitive.
final StopTokenFilter.Builder	removeTrailing(Boolean value)	If true, the last token of a stream is removed if it’s a stop word.
protected StopTokenFilter.Builder	self()
final StopTokenFilter.Builder	stopwords(String value, String... values)	Language value, such as _arabic_ or _thai_.
final StopTokenFilter.Builder	stopwords(List<String> list)	Language value, such as _arabic_ or _thai_.
final StopTokenFilter.Builder	stopwordsPath(String value)	Path to a file that contains a list of stop words to remove.

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

ignoreCase

public final StopTokenFilter.Builder ignoreCase(@Nullable
 Boolean value)

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

public final StopTokenFilter.Builder removeTrailing(@Nullable
 Boolean value)

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 StopTokenFilter.Builder stopwords(List<String> list)

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

API name: stopwords

Adds all elements of list to stopwords.

stopwords

public final StopTokenFilter.Builder stopwords(String value,
 String... values)

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

API name: stopwords

Adds one or more values to stopwords.

stopwordsPath

public final StopTokenFilter.Builder stopwordsPath(@Nullable
 String value)

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

self

protected StopTokenFilter.Builder self()

Specified by:

self in class TokenFilterBase.AbstractBuilder<StopTokenFilter.Builder>

build

public StopTokenFilter build()

Builds a StopTokenFilter.

Specified by:

build in interface ObjectBuilder<StopTokenFilter>

Throws:

NullPointerException - if some of the required fields are null.