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

Class AnalyzeToken.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.indices.analyze.AnalyzeToken.Builder

All Implemented Interfaces:

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

Enclosing class:

AnalyzeToken

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

Builder for AnalyzeToken.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
AnalyzeToken	build()	Builds a AnalyzeToken.
AnalyzeToken.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final AnalyzeToken.Builder	endOffset(int value)	Required - The ending character offset of the token.
final AnalyzeToken.Builder	position(int value)	Required - The position of the token.
final AnalyzeToken.Builder	positionLength(Integer value)	The length of the token position.
final AnalyzeToken.Builder	startOffset(int value)	Required - The starting character offset of the token.
final AnalyzeToken.Builder	token(String value)	Required - The token string.
final AnalyzeToken.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 AnalyzeToken.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<AnalyzeToken.Builder,AnalyzeToken>

Returns:

a new builder instance.

endOffset

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

Required - The ending character offset of the token.

API name: end_offset

position

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

Required - The position of the token.

API name: position

positionLength

@Nonnull
public final AnalyzeToken.Builder positionLength(@Nullable
 Integer value)

The length of the token position.

API name: positionLength

startOffset

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

Required - The starting character offset of the token.

API name: start_offset

token

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

Required - The token string.

API name: token

type

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

Required - The type of the token.

API name: type

build

@Nonnull
public AnalyzeToken build()

Builds a AnalyzeToken.

Specified by:

build in interface ObjectBuilder<AnalyzeToken>

Throws:

NullPointerException - if some of the required fields are null.