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

Class ShingleTokenFilter.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

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

org.opensearch.client.opensearch._types.analysis.ShingleTokenFilter.Builder

All Implemented Interfaces:

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

Enclosing class:

ShingleTokenFilter

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

Builder for ShingleTokenFilter.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ShingleTokenFilter	build()	Builds a ShingleTokenFilter.
ShingleTokenFilter.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final ShingleTokenFilter.Builder	fillerToken(String value)	API name: filler_token
final ShingleTokenFilter.Builder	maxShingleSize(Integer value)	API name: max_shingle_size
final ShingleTokenFilter.Builder	minShingleSize(Integer value)	API name: min_shingle_size
final ShingleTokenFilter.Builder	outputUnigrams(Boolean value)	API name: output_unigrams
final ShingleTokenFilter.Builder	outputUnigramsIfNoShingles(Boolean value)	API name: output_unigrams_if_no_shingles
protected ShingleTokenFilter.Builder	self()
final ShingleTokenFilter.Builder	tokenSeparator(String value)	API name: token_separator

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 ShingleTokenFilter.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<ShingleTokenFilter.Builder,ShingleTokenFilter>

Returns:

a new builder instance.

self

@Nonnull
protected ShingleTokenFilter.Builder self()

Specified by:

self in class TokenFilterBase.AbstractBuilder<ShingleTokenFilter.Builder>

fillerToken

@Nonnull
public final ShingleTokenFilter.Builder fillerToken(@Nullable
 String value)

API name: filler_token

maxShingleSize

@Nonnull
public final ShingleTokenFilter.Builder maxShingleSize(@Nullable
 Integer value)

API name: max_shingle_size

minShingleSize

@Nonnull
public final ShingleTokenFilter.Builder minShingleSize(@Nullable
 Integer value)

API name: min_shingle_size

outputUnigrams

@Nonnull
public final ShingleTokenFilter.Builder outputUnigrams(@Nullable
 Boolean value)

API name: output_unigrams

outputUnigramsIfNoShingles

@Nonnull
public final ShingleTokenFilter.Builder outputUnigramsIfNoShingles(@Nullable
 Boolean value)

API name: output_unigrams_if_no_shingles

tokenSeparator

@Nonnull
public final ShingleTokenFilter.Builder tokenSeparator(@Nullable
 String value)

API name: token_separator

build

@Nonnull
public ShingleTokenFilter build()

Builds a ShingleTokenFilter.

Specified by:

build in interface ObjectBuilder<ShingleTokenFilter>

Throws:

NullPointerException - if some of the required fields are null.