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

Class CommonGramsTokenFilter.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

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

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

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

All Implemented Interfaces:

WithJson<CommonGramsTokenFilter.Builder>, ObjectBuilder<CommonGramsTokenFilter>

Enclosing class:

CommonGramsTokenFilter

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

Builder for CommonGramsTokenFilter.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CommonGramsTokenFilter	build()	Builds a CommonGramsTokenFilter.
final CommonGramsTokenFilter.Builder	commonWords(String value, String... values)	A list of tokens.
final CommonGramsTokenFilter.Builder	commonWords(List<String> list)	A list of tokens.
final CommonGramsTokenFilter.Builder	commonWordsPath(String value)	Path to a file containing a list of tokens.
final CommonGramsTokenFilter.Builder	ignoreCase(Boolean value)	If true, matches for common words matching are case-insensitive.
final CommonGramsTokenFilter.Builder	queryMode(Boolean value)	If true, the filter excludes the following tokens from the output: Unigrams for common words Unigrams for terms followed by common words Defaults to false.
protected CommonGramsTokenFilter.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

commonWords

public final CommonGramsTokenFilter.Builder commonWords(List<String> list)

A list of tokens. The filter generates bigrams for these tokens. Either this or the common_words_path parameter is required.

API name: common_words

Adds all elements of list to commonWords.

commonWords

public final CommonGramsTokenFilter.Builder commonWords(String value,
 String... values)

A list of tokens. The filter generates bigrams for these tokens. Either this or the common_words_path parameter is required.

API name: common_words

Adds one or more values to commonWords.

commonWordsPath

public final CommonGramsTokenFilter.Builder commonWordsPath(@Nullable
 String value)

Path to a file containing a list of tokens. The filter generates bigrams for these tokens. This path must be absolute or relative to the config location. The file must be UTF-8 encoded. Each token in the file must be separated by a line break. Either this or the common_words parameter is required.

API name: common_words_path

ignoreCase

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

If true, matches for common words matching are case-insensitive. Defaults to false.

API name: ignore_case

queryMode

public final CommonGramsTokenFilter.Builder queryMode(@Nullable
 Boolean value)

If true, the filter excludes the following tokens from the output:

• Unigrams for common words
• Unigrams for terms followed by common words Defaults to false. We recommend enabling this parameter for search analyzers.

API name: query_mode

self

protected CommonGramsTokenFilter.Builder self()

Specified by:

self in class TokenFilterBase.AbstractBuilder<CommonGramsTokenFilter.Builder>

build

public CommonGramsTokenFilter build()

Builds a CommonGramsTokenFilter.

Specified by:

build in interface ObjectBuilder<CommonGramsTokenFilter>

Throws:

NullPointerException - if some of the required fields are null.