Package org.opensearch.client.opensearch.core

Class MgetResponse.Builder<TDocument>

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.core.MgetResponse.Builder<TDocument>

All Implemented Interfaces:

ObjectBuilder<MgetResponse<TDocument>>

Enclosing class:

MgetResponse<TDocument>

public static class MgetResponse.Builder<TDocument>
extends ObjectBuilderBase
implements ObjectBuilder<MgetResponse<TDocument>>

Builder for MgetResponse.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
MgetResponse<TDocument>	build()	Builds a MgetResponse.
MgetResponse.Builder<TDocument>	docs(java.util.function.Function<MultiGetResponseItem.Builder<TDocument>,ObjectBuilder<MultiGetResponseItem<TDocument>>> fn)	Required - API name: docs
MgetResponse.Builder<TDocument>	docs(java.util.List<MultiGetResponseItem<TDocument>> list)	Required - API name: docs
MgetResponse.Builder<TDocument>	docs(MultiGetResponseItem<TDocument> value, MultiGetResponseItem<TDocument>... values)	Required - API name: docs
MgetResponse.Builder<TDocument>	tDocumentSerializer(JsonpSerializer<TDocument> value)	Serializer for TDocument.

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

docs

public final MgetResponse.Builder<TDocument> docs(java.util.List<MultiGetResponseItem<TDocument>> list)

Required - API name: docs

Adds all elements of list to docs.

docs

public final MgetResponse.Builder<TDocument> docs(MultiGetResponseItem<TDocument> value,
                                                  MultiGetResponseItem<TDocument>... values)

Required - API name: docs

Adds one or more values to docs.

docs

public final MgetResponse.Builder<TDocument> docs(java.util.function.Function<MultiGetResponseItem.Builder<TDocument>,ObjectBuilder<MultiGetResponseItem<TDocument>>> fn)

Required - API name: docs

Adds a value to docs using a builder lambda.

tDocumentSerializer

public final MgetResponse.Builder<TDocument> tDocumentSerializer(@Nullable
                                                                 JsonpSerializer<TDocument> value)

Serializer for TDocument. If not set, an attempt will be made to find a serializer from the JSON context.

build

public MgetResponse<TDocument> build()

Builds a MgetResponse.

Specified by:

build in interface ObjectBuilder<TDocument>

Throws:

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