Package org.opensearch.client.opensearch.core

Class MgetRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.core.MgetRequest.Builder

All Implemented Interfaces:

ObjectBuilder<MgetRequest>

Enclosing class:

MgetRequest

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

Builder for MgetRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
MgetRequest	build()	Builds a MgetRequest.
final MgetRequest.Builder	docs(Function<MultiGetOperation.Builder,ObjectBuilder<MultiGetOperation>> fn)	API name: docs
final MgetRequest.Builder	docs(List<MultiGetOperation> list)	API name: docs
final MgetRequest.Builder	docs(MultiGetOperation value, MultiGetOperation... values)	API name: docs
final MgetRequest.Builder	ids(String value, String... values)	API name: ids
final MgetRequest.Builder	ids(List<String> list)	API name: ids
final MgetRequest.Builder	index(String value)	The name of the index
final MgetRequest.Builder	preference(String value)	Specify the node or shard the operation should be performed on (default: random)
final MgetRequest.Builder	realtime(Boolean value)	Specify whether to perform the operation in realtime or search mode
final MgetRequest.Builder	refresh(Boolean value)	Refresh the shard containing the document before performing the operation
final MgetRequest.Builder	routing(String value)	Specific routing value
final MgetRequest.Builder	source(Function<SourceConfigParam.Builder,ObjectBuilder<SourceConfigParam>> fn)	True or false to return the _source field or not, or a list of fields to return
final MgetRequest.Builder	source(SourceConfigParam value)	True or false to return the _source field or not, or a list of fields to return
final MgetRequest.Builder	sourceExcludes(String value, String... values)	A list of fields to exclude from the returned _source field
final MgetRequest.Builder	sourceExcludes(List<String> list)	A list of fields to exclude from the returned _source field
final MgetRequest.Builder	sourceIncludes(String value, String... values)	A list of fields to extract and return from the _source field
final MgetRequest.Builder	sourceIncludes(List<String> list)	A list of fields to extract and return from the _source field
final MgetRequest.Builder	storedFields(String value, String... values)	A comma-separated list of stored fields to return in the response
final MgetRequest.Builder	storedFields(List<String> list)	A comma-separated list of stored fields to return in the response

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

source

public final MgetRequest.Builder source(@Nullable
 SourceConfigParam value)

True or false to return the _source field or not, or a list of fields to return

API name: _source

source

public final MgetRequest.Builder source(Function<SourceConfigParam.Builder,ObjectBuilder<SourceConfigParam>> fn)

True or false to return the _source field or not, or a list of fields to return

API name: _source

sourceExcludes

public final MgetRequest.Builder sourceExcludes(List<String> list)

A list of fields to exclude from the returned _source field

API name: _source_excludes

Adds all elements of list to sourceExcludes.

sourceExcludes

public final MgetRequest.Builder sourceExcludes(String value,
 String... values)

A list of fields to exclude from the returned _source field

API name: _source_excludes

Adds one or more values to sourceExcludes.

sourceIncludes

public final MgetRequest.Builder sourceIncludes(List<String> list)

A list of fields to extract and return from the _source field

API name: _source_includes

Adds all elements of list to sourceIncludes.

sourceIncludes

public final MgetRequest.Builder sourceIncludes(String value,
 String... values)

A list of fields to extract and return from the _source field

API name: _source_includes

Adds one or more values to sourceIncludes.

docs

public final MgetRequest.Builder docs(List<MultiGetOperation> list)

API name: docs

Adds all elements of list to docs.

docs

public final MgetRequest.Builder docs(MultiGetOperation value,
 MultiGetOperation... values)

API name: docs

Adds one or more values to docs.

docs

public final MgetRequest.Builder docs(Function<MultiGetOperation.Builder,ObjectBuilder<MultiGetOperation>> fn)

API name: docs

Adds a value to docs using a builder lambda.

ids

public final MgetRequest.Builder ids(List<String> list)

API name: ids

Adds all elements of list to ids.

ids

public final MgetRequest.Builder ids(String value,
 String... values)

API name: ids

Adds one or more values to ids.

index

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

The name of the index

API name: index

preference

public final MgetRequest.Builder preference(@Nullable
 String value)

Specify the node or shard the operation should be performed on (default: random)

API name: preference

realtime

public final MgetRequest.Builder realtime(@Nullable
 Boolean value)

Specify whether to perform the operation in realtime or search mode

API name: realtime

refresh

public final MgetRequest.Builder refresh(@Nullable
 Boolean value)

Refresh the shard containing the document before performing the operation

API name: refresh

routing

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

Specific routing value

API name: routing

storedFields

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

A comma-separated list of stored fields to return in the response

API name: stored_fields

Adds all elements of list to storedFields.

storedFields

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

A comma-separated list of stored fields to return in the response

API name: stored_fields

Adds one or more values to storedFields.

build

public MgetRequest build()

Builds a MgetRequest.

Specified by:

build in interface ObjectBuilder<MgetRequest>

Throws:

NullPointerException - if some of the required fields are null.