Package org.opensearch.client.opensearch._types.analysis

Class CommonGramsTokenFilter.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch._types.analysis.TokenFilterBase.AbstractBuilder<CommonGramsTokenFilter.Builder>

org.opensearch.client.opensearch._types.analysis.CommonGramsTokenFilter.Builder

All Implemented Interfaces:

CopyableBuilder<CommonGramsTokenFilter.Builder,CommonGramsTokenFilter>, MutableBuilder<CommonGramsTokenFilter.Builder,CommonGramsTokenFilter>, ObjectBuilder<CommonGramsTokenFilter>

Enclosing class:

CommonGramsTokenFilter

public static class CommonGramsTokenFilter.Builder
extends TokenFilterBase.AbstractBuilder<CommonGramsTokenFilter.Builder>
implements CopyableBuilder<CommonGramsTokenFilter.Builder,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)	API name: common_words
final CommonGramsTokenFilter.Builder	commonWords(List<String> list)	API name: common_words
final CommonGramsTokenFilter.Builder	commonWordsPath(String value)	API name: common_words_path
CommonGramsTokenFilter.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final CommonGramsTokenFilter.Builder	ignoreCase(Boolean value)	API name: ignore_case
final CommonGramsTokenFilter.Builder	queryMode(Boolean value)	API name: query_mode
protected CommonGramsTokenFilter.Builder	self()

Methods inherited from class org.opensearch.client.opensearch._types.analysis.TokenFilterBase.AbstractBuilder

version

Methods inherited from class org.opensearch.client.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _listCopy, _mapCopy, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.client.util.MutableBuilder

applyMutation

Constructor Details

Builder

public Builder()

Method Details

copy

@Nonnull
public CommonGramsTokenFilter.Builder copy()

Description copied from interface: CopyableBuilder

Create a new builder CopyableBuilder that is a copy of this one.

Specified by:

copy in interface CopyableBuilder<CommonGramsTokenFilter.Builder,CommonGramsTokenFilter>

Returns:

a new builder instance.

self

@Nonnull
protected CommonGramsTokenFilter.Builder self()

Specified by:

self in class TokenFilterBase.AbstractBuilder<CommonGramsTokenFilter.Builder>

commonWords

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

API name: common_words

Adds all elements of list to commonWords.

commonWords

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

API name: common_words

Adds one or more values to commonWords.

commonWordsPath

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

API name: common_words_path

ignoreCase

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

API name: ignore_case

queryMode

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

API name: query_mode

build

@Nonnull
public CommonGramsTokenFilter build()

Builds a CommonGramsTokenFilter.

Specified by:

build in interface ObjectBuilder<CommonGramsTokenFilter>

Throws:

NullPointerException - if some of the required fields are null.