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:

ObjectBuilder<Term>

Enclosing class:

Term

public static class Term.Builder
extends ObjectBuilderBase
implements ObjectBuilder<Term>

Builder for Term.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
Term	build()	Builds a Term.
Term.Builder	docFreq(java.lang.Integer value)	API name: doc_freq
Term.Builder	score(java.lang.Double value)	API name: score
Term.Builder	termFreq(int value)	Required - API name: term_freq
Term.Builder	tokens(java.util.function.Function<Token.Builder,ObjectBuilder<Token>> fn)	Required - API name: tokens
Term.Builder	tokens(java.util.List<Token> list)	Required - API name: tokens
Term.Builder	tokens(Token value, Token... values)	Required - API name: tokens
Term.Builder	ttf(java.lang.Integer value)	API name: ttf

Methods inherited from class org.opensearch.client.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

docFreq

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

API name: doc_freq

score

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

API name: score

termFreq

public final Term.Builder termFreq(int value)

Required - API name: term_freq

tokens

public final Term.Builder tokens(java.util.List<Token> list)

Required - API name: tokens

Adds all elements of list to tokens.

tokens

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

Required - API name: tokens

Adds one or more values to tokens.

tokens

public final Term.Builder tokens(java.util.function.Function<Token.Builder,ObjectBuilder<Token>> fn)

Required - API name: tokens

Adds a value to tokens using a builder lambda.

ttf

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

API name: ttf

build

public Term build()

Builds a Term.

Specified by:

build in interface ObjectBuilder<Term>

Throws:

java.lang.NullPointerException - if some of the required fields are null.