Package org.opensearch.client.opensearch.core.mtermvectors

Class MultiTermVectorsResult.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.core.mtermvectors.MultiTermVectorsResult.Builder

All Implemented Interfaces:

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

Enclosing class:

MultiTermVectorsResult

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

Builder for MultiTermVectorsResult.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
MultiTermVectorsResult	build()	Builds a MultiTermVectorsResult.
MultiTermVectorsResult.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final MultiTermVectorsResult.Builder	error(Function<ErrorCause.Builder,ObjectBuilder<ErrorCause>> fn)	API name: error
final MultiTermVectorsResult.Builder	error(ErrorCause value)	API name: error
final MultiTermVectorsResult.Builder	found(Boolean value)	API name: found
final MultiTermVectorsResult.Builder	id(String value)	Required - API name: _id
final MultiTermVectorsResult.Builder	index(String value)	Required - API name: _index
final MultiTermVectorsResult.Builder	termVectors(String key, Function<TermVector.Builder,ObjectBuilder<TermVector>> fn)	API name: term_vectors
final MultiTermVectorsResult.Builder	termVectors(String key, TermVector value)	API name: term_vectors
final MultiTermVectorsResult.Builder	termVectors(Map<String,TermVector> map)	API name: term_vectors
final MultiTermVectorsResult.Builder	took(Long value)	API name: took
final MultiTermVectorsResult.Builder	version(Long value)	API name: _version

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

Returns:

a new builder instance.

error

@Nonnull
public final MultiTermVectorsResult.Builder error(@Nullable
 ErrorCause value)

API name: error

error

@Nonnull
public final MultiTermVectorsResult.Builder error(Function<ErrorCause.Builder,ObjectBuilder<ErrorCause>> fn)

API name: error

found

@Nonnull
public final MultiTermVectorsResult.Builder found(@Nullable
 Boolean value)

API name: found

id

@Nonnull
public final MultiTermVectorsResult.Builder id(String value)

Required - API name: _id

index

@Nonnull
public final MultiTermVectorsResult.Builder index(String value)

Required - API name: _index

termVectors

@Nonnull
public final MultiTermVectorsResult.Builder termVectors(Map<String,TermVector> map)

API name: term_vectors

Adds all elements of map to termVectors.

termVectors

@Nonnull
public final MultiTermVectorsResult.Builder termVectors(String key,
 TermVector value)

API name: term_vectors

Adds an entry to termVectors.

termVectors

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

API name: term_vectors

Adds a value to termVectors using a builder lambda.

took

@Nonnull
public final MultiTermVectorsResult.Builder took(@Nullable
 Long value)

API name: took

version

@Nonnull
public final MultiTermVectorsResult.Builder version(@Nullable
 Long value)

API name: _version

build

@Nonnull
public MultiTermVectorsResult build()

Builds a MultiTermVectorsResult.

Specified by:

build in interface ObjectBuilder<MultiTermVectorsResult>

Throws:

NullPointerException - if some of the required fields are null.