Package co.elastic.clients.elasticsearch.core.mget

Class MultiGetOperation.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<MultiGetOperation.Builder>

co.elastic.clients.elasticsearch.core.mget.MultiGetOperation.Builder

All Implemented Interfaces:

WithJson<MultiGetOperation.Builder>, ObjectBuilder<MultiGetOperation>

Enclosing class:

MultiGetOperation

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

Builder for MultiGetOperation.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
MultiGetOperation	build()	Builds a MultiGetOperation.
MultiGetOperation.Builder	id(java.lang.String value)	Required - The unique document ID.
MultiGetOperation.Builder	index(java.lang.String value)	The index that contains the document.
MultiGetOperation.Builder	routing(java.lang.String value)	The key for the primary shard the document resides on.
protected MultiGetOperation.Builder	self()
MultiGetOperation.Builder	source(SourceConfig value)	If false, excludes all _source fields.
MultiGetOperation.Builder	source(java.util.function.Function<SourceConfig.Builder,ObjectBuilder<SourceConfig>> fn)	If false, excludes all _source fields.
MultiGetOperation.Builder	storedFields(java.lang.String value, java.lang.String... values)	The stored fields you want to retrieve.
MultiGetOperation.Builder	storedFields(java.util.List<java.lang.String> list)	The stored fields you want to retrieve.
MultiGetOperation.Builder	version(java.lang.Long value)	API name: version
MultiGetOperation.Builder	versionType(VersionType value)	API name: version_type

Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase

withJson

Methods inherited from class co.elastic.clients.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

Methods inherited from interface co.elastic.clients.json.WithJson

withJson, withJson

Constructor Details

Builder

public Builder()

Method Details

id

public final MultiGetOperation.Builder id(java.lang.String value)

Required - The unique document ID.

API name: _id

index

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

The index that contains the document.

API name: _index

routing

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

The key for the primary shard the document resides on. Required if routing is used during indexing.

API name: routing

source

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

If false, excludes all _source fields.

API name: _source

source

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

If false, excludes all _source fields.

API name: _source

storedFields

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

The stored fields you want to retrieve.

API name: stored_fields

Adds all elements of list to storedFields.

storedFields

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

The stored fields you want to retrieve.

API name: stored_fields

Adds one or more values to storedFields.

version

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

API name: version

versionType

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

API name: version_type

self

protected MultiGetOperation.Builder self()

Specified by:

self in class WithJsonObjectBuilderBase<MultiGetOperation.Builder>

build

public MultiGetOperation build()

Builds a MultiGetOperation.

Specified by:

build in interface ObjectBuilder<MultiGetOperation>

Throws:

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