Class MgetRequest.Builder
- All Implemented Interfaces:
ObjectBuilder<MgetRequest>
- Enclosing class:
- MgetRequest
public static class MgetRequest.Builder extends ObjectBuilderBase implements ObjectBuilder<MgetRequest>
MgetRequest
.-
Constructor Summary
Constructors Constructor Description Builder()
-
Method Summary
Modifier and Type Method Description MgetRequest
build()
Builds aMgetRequest
.MgetRequest.Builder
docs(MultiGetOperation value, MultiGetOperation... values)
API name:docs
MgetRequest.Builder
docs(java.util.function.Function<MultiGetOperation.Builder,ObjectBuilder<MultiGetOperation>> fn)
API name:docs
MgetRequest.Builder
docs(java.util.List<MultiGetOperation> list)
API name:docs
MgetRequest.Builder
ids(java.lang.String value, java.lang.String... values)
API name:ids
MgetRequest.Builder
ids(java.util.List<java.lang.String> list)
API name:ids
MgetRequest.Builder
index(java.lang.String value)
The name of the indexMgetRequest.Builder
preference(java.lang.String value)
Specify the node or shard the operation should be performed on (default: random)MgetRequest.Builder
realtime(java.lang.Boolean value)
Specify whether to perform the operation in realtime or search modeMgetRequest.Builder
refresh(java.lang.Boolean value)
Refresh the shard containing the document before performing the operationMgetRequest.Builder
routing(java.lang.String value)
Specific routing valueMgetRequest.Builder
source(SourceConfigParam value)
True or false to return the _source field or not, or a list of fields to returnMgetRequest.Builder
source(java.util.function.Function<SourceConfigParam.Builder,ObjectBuilder<SourceConfigParam>> fn)
True or false to return the _source field or not, or a list of fields to returnMgetRequest.Builder
sourceExcludes(java.lang.String value, java.lang.String... values)
A list of fields to exclude from the returned _source fieldMgetRequest.Builder
sourceExcludes(java.util.List<java.lang.String> list)
A list of fields to exclude from the returned _source fieldMgetRequest.Builder
sourceIncludes(java.lang.String value, java.lang.String... values)
A list of fields to extract and return from the _source fieldMgetRequest.Builder
sourceIncludes(java.util.List<java.lang.String> list)
A list of fields to extract and return from the _source fieldMgetRequest.Builder
storedFields(java.lang.String value, java.lang.String... values)
A comma-separated list of stored fields to return in the responseMgetRequest.Builder
storedFields(java.util.List<java.lang.String> list)
A comma-separated list of stored fields to return in the responseMgetRequest.Builder
type(java.lang.String value)
The type of the documentMethods 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
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
source
True or false to return the _source field or not, or a list of fields to returnAPI name:
_source
-
source
public final MgetRequest.Builder source(java.util.function.Function<SourceConfigParam.Builder,ObjectBuilder<SourceConfigParam>> fn)True or false to return the _source field or not, or a list of fields to returnAPI name:
_source
-
sourceExcludes
A list of fields to exclude from the returned _source fieldAPI name:
_source_excludes
Adds all elements of
list
tosourceExcludes
. -
sourceExcludes
public final MgetRequest.Builder sourceExcludes(java.lang.String value, java.lang.String... values)A list of fields to exclude from the returned _source fieldAPI name:
_source_excludes
Adds one or more values to
sourceExcludes
. -
sourceIncludes
A list of fields to extract and return from the _source fieldAPI name:
_source_includes
Adds all elements of
list
tosourceIncludes
. -
sourceIncludes
public final MgetRequest.Builder sourceIncludes(java.lang.String value, java.lang.String... values)A list of fields to extract and return from the _source fieldAPI name:
_source_includes
Adds one or more values to
sourceIncludes
. -
docs
API name:docs
Adds all elements of
list
todocs
. -
docs
API name:docs
Adds one or more values to
docs
. -
docs
public final MgetRequest.Builder docs(java.util.function.Function<MultiGetOperation.Builder,ObjectBuilder<MultiGetOperation>> fn)API name:docs
Adds a value to
docs
using a builder lambda. -
ids
API name:ids
Adds all elements of
list
toids
. -
ids
API name:ids
Adds one or more values to
ids
. -
index
The name of the indexAPI name:
index
-
preference
Specify the node or shard the operation should be performed on (default: random)API name:
preference
-
realtime
Specify whether to perform the operation in realtime or search modeAPI name:
realtime
-
refresh
Refresh the shard containing the document before performing the operationAPI name:
refresh
-
routing
Specific routing valueAPI name:
routing
-
storedFields
A comma-separated list of stored fields to return in the responseAPI name:
stored_fields
Adds all elements of
list
tostoredFields
. -
storedFields
A comma-separated list of stored fields to return in the responseAPI name:
stored_fields
Adds one or more values to
storedFields
. -
type
The type of the documentAPI name:
type
-
build
Builds aMgetRequest
.- Specified by:
build
in interfaceObjectBuilder<MgetRequest>
- Throws:
java.lang.NullPointerException
- if some of the required fields are null.
-