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

Class KeepWordsTokenFilter.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

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

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

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

All Implemented Interfaces:

WithJson<KeepWordsTokenFilter.Builder>, ObjectBuilder<KeepWordsTokenFilter>

Enclosing class:

KeepWordsTokenFilter

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

Builder for KeepWordsTokenFilter.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
KeepWordsTokenFilter	build()	Builds a KeepWordsTokenFilter.
final KeepWordsTokenFilter.Builder	keepWords(String value, String... values)	List of words to keep.
final KeepWordsTokenFilter.Builder	keepWords(List<String> list)	List of words to keep.
final KeepWordsTokenFilter.Builder	keepWordsCase(Boolean value)	If true, lowercase all keep words.
final KeepWordsTokenFilter.Builder	keepWordsPath(String value)	Path to a file that contains a list of words to keep.
protected KeepWordsTokenFilter.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

keepWords

public final KeepWordsTokenFilter.Builder keepWords(List<String> list)

List of words to keep. Only tokens that match words in this list are included in the output. Either this parameter or keep_words_path must be specified.

API name: keep_words

Adds all elements of list to keepWords.

keepWords

public final KeepWordsTokenFilter.Builder keepWords(String value,
 String... values)

List of words to keep. Only tokens that match words in this list are included in the output. Either this parameter or keep_words_path must be specified.

API name: keep_words

Adds one or more values to keepWords.

keepWordsCase

public final KeepWordsTokenFilter.Builder keepWordsCase(@Nullable
 Boolean value)

If true, lowercase all keep words. Defaults to false.

API name: keep_words_case

keepWordsPath

public final KeepWordsTokenFilter.Builder keepWordsPath(@Nullable
 String value)

Path to a file that contains a list of words to keep. Only tokens that match words in this list are included in the output. 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. Either this parameter or keep_words must be specified.

API name: keep_words_path

self

protected KeepWordsTokenFilter.Builder self()

Specified by:

self in class TokenFilterBase.AbstractBuilder<KeepWordsTokenFilter.Builder>

build

public KeepWordsTokenFilter build()

Builds a KeepWordsTokenFilter.

Specified by:

build in interface ObjectBuilder<KeepWordsTokenFilter>

Throws:

NullPointerException - if some of the required fields are null.