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

Class TermVector.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.core.termvectors.TermVector.Builder

All Implemented Interfaces:

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

Enclosing class:

TermVector

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

Builder for TermVector.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
TermVector	build()	Builds a TermVector.
TermVector.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final TermVector.Builder	fieldStatistics(Function<FieldStatistics.Builder,ObjectBuilder<FieldStatistics>> fn)	API name: field_statistics
final TermVector.Builder	fieldStatistics(FieldStatistics value)	API name: field_statistics
final TermVector.Builder	terms(String key, Function<Term.Builder,ObjectBuilder<Term>> fn)	Required - API name: terms
final TermVector.Builder	terms(String key, Term value)	Required - API name: terms
final TermVector.Builder	terms(Map<String,Term> map)	Required - API name: terms

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

Returns:

a new builder instance.

fieldStatistics

@Nonnull
public final TermVector.Builder fieldStatistics(@Nullable
 FieldStatistics value)

API name: field_statistics

fieldStatistics

@Nonnull
public final TermVector.Builder fieldStatistics(Function<FieldStatistics.Builder,ObjectBuilder<FieldStatistics>> fn)

API name: field_statistics

terms

@Nonnull
public final TermVector.Builder terms(Map<String,Term> map)

Required - API name: terms

Adds all elements of map to terms.

terms

@Nonnull
public final TermVector.Builder terms(String key,
 Term value)

Required - API name: terms

Adds an entry to terms.

terms

@Nonnull
public final TermVector.Builder terms(String key,
 Function<Term.Builder,ObjectBuilder<Term>> fn)

Required - API name: terms

Adds a value to terms using a builder lambda.

build

@Nonnull
public TermVector build()

Builds a TermVector.

Specified by:

build in interface ObjectBuilder<TermVector>

Throws:

NullPointerException - if some of the required fields are null.