Package org.opensearch.client.opensearch.core.termvectors

Class Token.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.core.termvectors.Token.Builder

All Implemented Interfaces:

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

Enclosing class:

Token

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

Builder for Token.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
Token	build()	Builds a Token.
Token.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final Token.Builder	endOffset(Integer value)	API name: end_offset
final Token.Builder	payload(String value)	API name: payload
final Token.Builder	position(int value)	Required - API name: position
final Token.Builder	startOffset(Integer value)	API name: start_offset

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

Returns:

a new builder instance.

endOffset

@Nonnull
public final Token.Builder endOffset(@Nullable
 Integer value)

API name: end_offset

payload

@Nonnull
public final Token.Builder payload(@Nullable
 String value)

API name: payload

position

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

Required - API name: position

startOffset

@Nonnull
public final Token.Builder startOffset(@Nullable
 Integer value)

API name: start_offset

build

@Nonnull
public Token build()

Builds a Token.

Specified by:

build in interface ObjectBuilder<Token>

Throws:

NullPointerException - if some of the required fields are null.