Class MgetRequest.Builder
- All Implemented Interfaces:
ObjectBuilder<MgetRequest>
- Enclosing class:
MgetRequest
MgetRequest.-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbuild()Builds aMgetRequest.final MgetRequest.BuilderAPI name:docsfinal MgetRequest.Builderdocs(List<MultiGetOperation> list) API name:docsfinal MgetRequest.Builderdocs(MultiGetOperation value, MultiGetOperation... values) API name:docsfinal MgetRequest.BuilderAPI name:idsfinal MgetRequest.BuilderAPI name:idsfinal MgetRequest.BuilderThe name of the indexfinal MgetRequest.Builderpreference(String value) Specify the node or shard the operation should be performed on (default: random)final MgetRequest.BuilderSpecify whether to perform the operation in realtime or search modefinal MgetRequest.BuilderRefresh the shard containing the document before performing the operationfinal MgetRequest.BuilderSpecific routing valuefinal MgetRequest.BuilderTrue or false to return the _source field or not, or a list of fields to returnfinal MgetRequest.Buildersource(SourceConfigParam value) True or false to return the _source field or not, or a list of fields to returnfinal MgetRequest.BuildersourceExcludes(String value, String... values) A list of fields to exclude from the returned _source fieldfinal MgetRequest.BuildersourceExcludes(List<String> list) A list of fields to exclude from the returned _source fieldfinal MgetRequest.BuildersourceIncludes(String value, String... values) A list of fields to extract and return from the _source fieldfinal MgetRequest.BuildersourceIncludes(List<String> list) A list of fields to extract and return from the _source fieldfinal MgetRequest.BuilderstoredFields(String value, String... values) A comma-separated list of stored fields to return in the responsefinal MgetRequest.BuilderstoredFields(List<String> list) A comma-separated list of stored fields to return in the responseMethods inherited from class org.opensearch.client.util.ObjectBuilderBase
_checkSingleUse, _listAdd, _listAddAll, _listCopy, _mapCopy, _mapPut, _mapPutAll
-
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(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_excludesAdds all elements of
listtosourceExcludes. -
sourceExcludes
A list of fields to exclude from the returned _source fieldAPI name:
_source_excludesAdds one or more values to
sourceExcludes. -
sourceIncludes
A list of fields to extract and return from the _source fieldAPI name:
_source_includesAdds all elements of
listtosourceIncludes. -
sourceIncludes
A list of fields to extract and return from the _source fieldAPI name:
_source_includesAdds one or more values to
sourceIncludes. -
docs
API name:docsAdds all elements of
listtodocs. -
docs
API name:docsAdds one or more values to
docs. -
docs
public final MgetRequest.Builder docs(Function<MultiGetOperation.Builder, ObjectBuilder<MultiGetOperation>> fn) API name:docsAdds a value to
docsusing a builder lambda. -
ids
API name:idsAdds all elements of
listtoids. -
ids
API name:idsAdds 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_fieldsAdds all elements of
listtostoredFields. -
storedFields
A comma-separated list of stored fields to return in the responseAPI name:
stored_fieldsAdds one or more values to
storedFields. -
build
Builds aMgetRequest.- Specified by:
buildin interfaceObjectBuilder<MgetRequest>- Throws:
NullPointerException- if some of the required fields are null.
-