Package org.opensearch.client.opensearch.core.mget

Class MultiGetOperation.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.core.mget.MultiGetOperation.Builder

All Implemented Interfaces:

ObjectBuilder<MultiGetOperation>

Enclosing class:

MultiGetOperation

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

Builder for MultiGetOperation.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
MultiGetOperation	build()	Builds a MultiGetOperation.
final MultiGetOperation.Builder	id(String value)	Required - API name: _id
final MultiGetOperation.Builder	index(String value)	API name: _index
final MultiGetOperation.Builder	routing(String value)	API name: routing
final MultiGetOperation.Builder	source(Function<SourceConfig.Builder,ObjectBuilder<SourceConfig>> fn)	API name: _source
final MultiGetOperation.Builder	source(SourceConfig value)	API name: _source
final MultiGetOperation.Builder	storedFields(String value, String... values)	API name: stored_fields
final MultiGetOperation.Builder	storedFields(List<String> list)	API name: stored_fields
final MultiGetOperation.Builder	version(Long value)	API name: version
final MultiGetOperation.Builder	versionType(VersionType value)	API name: version_type

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

Constructor Details

Builder

public Builder()

Method Details

id

public final MultiGetOperation.Builder id(String value)

Required - API name: _id

index

public final MultiGetOperation.Builder index(@Nullable
 String value)

API name: _index

routing

public final MultiGetOperation.Builder routing(@Nullable
 String value)

API name: routing

source

public final MultiGetOperation.Builder source(@Nullable
 SourceConfig value)

API name: _source

source

public final MultiGetOperation.Builder source(Function<SourceConfig.Builder,ObjectBuilder<SourceConfig>> fn)

API name: _source

storedFields

public final MultiGetOperation.Builder storedFields(List<String> list)

API name: stored_fields

Adds all elements of list to storedFields.

storedFields

public final MultiGetOperation.Builder storedFields(String value,
 String... values)

API name: stored_fields

Adds one or more values to storedFields.

version

public final MultiGetOperation.Builder version(@Nullable
 Long value)

API name: version

versionType

public final MultiGetOperation.Builder versionType(@Nullable
 VersionType value)

API name: version_type

build

public MultiGetOperation build()

Builds a MultiGetOperation.

Specified by:

build in interface ObjectBuilder<MultiGetOperation>

Throws:

NullPointerException - if some of the required fields are null.