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

Class ExplainAnalyzeToken.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.indices.analyze.ExplainAnalyzeToken.Builder

All Implemented Interfaces:

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

Enclosing class:

ExplainAnalyzeToken

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

Builder for ExplainAnalyzeToken.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ExplainAnalyzeToken	build()	Builds a ExplainAnalyzeToken.
final ExplainAnalyzeToken.Builder	bytes(String value)	Required - The bytes representation of the token.
ExplainAnalyzeToken.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final ExplainAnalyzeToken.Builder	endOffset(int value)	Required - The ending character offset of the token.
final ExplainAnalyzeToken.Builder	keyword(Boolean value)	Whether the token is a keyword.
final ExplainAnalyzeToken.Builder	position(int value)	Required - The position of the token.
final ExplainAnalyzeToken.Builder	positionLength(int value)	Required - The length of the token position.
final ExplainAnalyzeToken.Builder	startOffset(int value)	Required - The starting character offset of the token.
final ExplainAnalyzeToken.Builder	termFrequency(int value)	Required - The frequency of the term.
final ExplainAnalyzeToken.Builder	token(String value)	Required - The token string.
final ExplainAnalyzeToken.Builder	type(String value)	Required - The type of the token.

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

Returns:

a new builder instance.

bytes

@Nonnull
public final ExplainAnalyzeToken.Builder bytes(String value)

Required - The bytes representation of the token.

API name: bytes

endOffset

@Nonnull
public final ExplainAnalyzeToken.Builder endOffset(int value)

Required - The ending character offset of the token.

API name: end_offset

keyword

@Nonnull
public final ExplainAnalyzeToken.Builder keyword(@Nullable
 Boolean value)

Whether the token is a keyword.

API name: keyword

position

@Nonnull
public final ExplainAnalyzeToken.Builder position(int value)

Required - The position of the token.

API name: position

positionLength

@Nonnull
public final ExplainAnalyzeToken.Builder positionLength(int value)

Required - The length of the token position.

API name: positionLength

startOffset

@Nonnull
public final ExplainAnalyzeToken.Builder startOffset(int value)

Required - The starting character offset of the token.

API name: start_offset

termFrequency

@Nonnull
public final ExplainAnalyzeToken.Builder termFrequency(int value)

Required - The frequency of the term.

API name: termFrequency

token

@Nonnull
public final ExplainAnalyzeToken.Builder token(String value)

Required - The token string.

API name: token

type

@Nonnull
public final ExplainAnalyzeToken.Builder type(String value)

Required - The type of the token.

API name: type

build

@Nonnull
public ExplainAnalyzeToken build()

Builds a ExplainAnalyzeToken.

Specified by:

build in interface ObjectBuilder<ExplainAnalyzeToken>

Throws:

NullPointerException - if some of the required fields are null.