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

Class PhoneticTokenFilter.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

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

org.opensearch.client.opensearch._types.analysis.PhoneticTokenFilter.Builder

All Implemented Interfaces:

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

Enclosing class:

PhoneticTokenFilter

public static class PhoneticTokenFilter.Builder
extends TokenFilterBase.AbstractBuilder<PhoneticTokenFilter.Builder>
implements CopyableBuilder<PhoneticTokenFilter.Builder,PhoneticTokenFilter>

Builder for PhoneticTokenFilter.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
PhoneticTokenFilter	build()	Builds a PhoneticTokenFilter.
PhoneticTokenFilter.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final PhoneticTokenFilter.Builder	encoder(PhoneticEncoder value)	Required - API name: encoder
final PhoneticTokenFilter.Builder	languageset(List<PhoneticLanguage> list)	Required - API name: languageset
final PhoneticTokenFilter.Builder	languageset(PhoneticLanguage value, PhoneticLanguage... values)	Required - API name: languageset
final PhoneticTokenFilter.Builder	maxCodeLen(Integer value)	API name: max_code_len
final PhoneticTokenFilter.Builder	nameType(PhoneticNameType value)	Required - API name: name_type
final PhoneticTokenFilter.Builder	replace(Boolean value)	API name: replace
final PhoneticTokenFilter.Builder	ruleType(PhoneticRuleType value)	Required - API name: rule_type
protected PhoneticTokenFilter.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 PhoneticTokenFilter.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<PhoneticTokenFilter.Builder,PhoneticTokenFilter>

Returns:

a new builder instance.

self

@Nonnull
protected PhoneticTokenFilter.Builder self()

Specified by:

self in class TokenFilterBase.AbstractBuilder<PhoneticTokenFilter.Builder>

encoder

@Nonnull
public final PhoneticTokenFilter.Builder encoder(PhoneticEncoder value)

Required - API name: encoder

languageset

@Nonnull
public final PhoneticTokenFilter.Builder languageset(List<PhoneticLanguage> list)

Required - API name: languageset

Adds all elements of list to languageset.

languageset

@Nonnull
public final PhoneticTokenFilter.Builder languageset(PhoneticLanguage value,
 PhoneticLanguage... values)

Required - API name: languageset

Adds one or more values to languageset.

maxCodeLen

@Nonnull
public final PhoneticTokenFilter.Builder maxCodeLen(@Nullable
 Integer value)

API name: max_code_len

nameType

@Nonnull
public final PhoneticTokenFilter.Builder nameType(PhoneticNameType value)

Required - API name: name_type

replace

@Nonnull
public final PhoneticTokenFilter.Builder replace(@Nullable
 Boolean value)

API name: replace

ruleType

@Nonnull
public final PhoneticTokenFilter.Builder ruleType(PhoneticRuleType value)

Required - API name: rule_type

build

@Nonnull
public PhoneticTokenFilter build()

Builds a PhoneticTokenFilter.

Specified by:

build in interface ObjectBuilder<PhoneticTokenFilter>

Throws:

NullPointerException - if some of the required fields are null.