Package org.opensearch.client.opensearch.indices.analyze

Class TokenDetail.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.indices.analyze.TokenDetail.Builder

All Implemented Interfaces:

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

Enclosing class:

TokenDetail

public static class TokenDetail.Builder
extends ObjectBuilderBase
implements CopyableBuilder<TokenDetail.Builder,TokenDetail>

Builder for TokenDetail.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
TokenDetail	build()	Builds a TokenDetail.
TokenDetail.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final TokenDetail.Builder	name(String value)	Required - The name of the token filter or tokenizer.
final TokenDetail.Builder	tokens(Function<ExplainAnalyzeToken.Builder,ObjectBuilder<ExplainAnalyzeToken>> fn)	Required - The list of tokens produced.
final TokenDetail.Builder	tokens(List<ExplainAnalyzeToken> list)	Required - The list of tokens produced.
final TokenDetail.Builder	tokens(ExplainAnalyzeToken value, ExplainAnalyzeToken... values)	Required - The list of tokens produced.

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

Returns:

a new builder instance.

name

@Nonnull
public final TokenDetail.Builder name(String value)

Required - The name of the token filter or tokenizer.

API name: name

tokens

@Nonnull
public final TokenDetail.Builder tokens(List<ExplainAnalyzeToken> list)

Required - The list of tokens produced.

API name: tokens

Adds all elements of list to tokens.

tokens

@Nonnull
public final TokenDetail.Builder tokens(ExplainAnalyzeToken value,
 ExplainAnalyzeToken... values)

Required - The list of tokens produced.

API name: tokens

Adds one or more values to tokens.

tokens

@Nonnull
public final TokenDetail.Builder tokens(Function<ExplainAnalyzeToken.Builder,ObjectBuilder<ExplainAnalyzeToken>> fn)

Required - The list of tokens produced.

API name: tokens

Adds a value to tokens using a builder lambda.

build

@Nonnull
public TokenDetail build()

Builds a TokenDetail.

Specified by:

build in interface ObjectBuilder<TokenDetail>

Throws:

NullPointerException - if some of the required fields are null.