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

Class Term.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.core.termvectors.Term.Builder

All Implemented Interfaces:

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

Enclosing class:

Term

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

Builder for Term.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
Term	build()	Builds a Term.
Term.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final Term.Builder	docFreq(Integer value)	API name: doc_freq
final Term.Builder	score(Double value)	API name: score
final Term.Builder	termFreq(int value)	Required - API name: term_freq
final Term.Builder	tokens(Function<Token.Builder,ObjectBuilder<Token>> fn)	API name: tokens
final Term.Builder	tokens(List<Token> list)	API name: tokens
final Term.Builder	tokens(Token value, Token... values)	API name: tokens
final Term.Builder	ttf(Integer value)	API name: ttf

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

Returns:

a new builder instance.

docFreq

@Nonnull
public final Term.Builder docFreq(@Nullable
 Integer value)

API name: doc_freq

score

@Nonnull
public final Term.Builder score(@Nullable
 Double value)

API name: score

termFreq

@Nonnull
public final Term.Builder termFreq(int value)

Required - API name: term_freq

tokens

@Nonnull
public final Term.Builder tokens(List<Token> list)

API name: tokens

Adds all elements of list to tokens.

tokens

@Nonnull
public final Term.Builder tokens(Token value,
 Token... values)

API name: tokens

Adds one or more values to tokens.

tokens

@Nonnull
public final Term.Builder tokens(Function<Token.Builder,ObjectBuilder<Token>> fn)

API name: tokens

Adds a value to tokens using a builder lambda.

ttf

@Nonnull
public final Term.Builder ttf(@Nullable
 Integer value)

API name: ttf

build

@Nonnull
public Term build()

Builds a Term.

Specified by:

build in interface ObjectBuilder<Term>

Throws:

NullPointerException - if some of the required fields are null.