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

Class NGramTokenizer.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch._types.analysis.TokenizerBase.AbstractBuilder<NGramTokenizer.Builder>

org.opensearch.client.opensearch._types.analysis.NGramTokenizer.Builder

All Implemented Interfaces:

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

Enclosing class:

NGramTokenizer

public static class NGramTokenizer.Builder
extends TokenizerBase.AbstractBuilder<NGramTokenizer.Builder>
implements CopyableBuilder<NGramTokenizer.Builder,NGramTokenizer>

Builder for NGramTokenizer.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
NGramTokenizer	build()	Builds a NGramTokenizer.
NGramTokenizer.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
NGramTokenizer.Builder	customTokenChars(java.lang.String value)	API name: custom_token_chars
NGramTokenizer.Builder	maxGram(int value)	Required - API name: max_gram
NGramTokenizer.Builder	minGram(int value)	Required - API name: min_gram
protected NGramTokenizer.Builder	self()
NGramTokenizer.Builder	tokenChars(java.util.List<TokenChar> list)	Required - API name: token_chars
NGramTokenizer.Builder	tokenChars(TokenChar value, TokenChar... values)	Required - API name: token_chars

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

version

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

_checkSingleUse, _listAdd, _listAdd, _listAddAll, _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 Detail

Builder

public Builder()

Method Detail

copy

@Nonnull
public NGramTokenizer.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<NGramTokenizer.Builder,NGramTokenizer>

Returns:

a new builder instance.

self

@Nonnull
protected NGramTokenizer.Builder self()

Specified by:

self in class TokenizerBase.AbstractBuilder<NGramTokenizer.Builder>

customTokenChars

@Nonnull
public final NGramTokenizer.Builder customTokenChars(@Nullable
                                                     java.lang.String value)

API name: custom_token_chars

maxGram

@Nonnull
public final NGramTokenizer.Builder maxGram(int value)

Required - API name: max_gram

minGram

@Nonnull
public final NGramTokenizer.Builder minGram(int value)

Required - API name: min_gram

tokenChars

@Nonnull
public final NGramTokenizer.Builder tokenChars(java.util.List<TokenChar> list)

Required - API name: token_chars

Adds all elements of list to tokenChars.

tokenChars

@Nonnull
public final NGramTokenizer.Builder tokenChars(TokenChar value,
                                               TokenChar... values)

Required - API name: token_chars

Adds one or more values to tokenChars.

build

@Nonnull
public NGramTokenizer build()

Builds a NGramTokenizer.

Specified by:

build in interface ObjectBuilder<NGramTokenizer>

Throws:

java.lang.NullPointerException - if some of the required fields are null.