Package org.elasticsearch.action.get
Class MultiGetRequestBuilder
java.lang.Object
org.elasticsearch.action.ActionRequestBuilder<MultiGetRequest,MultiGetResponse>
org.elasticsearch.action.get.MultiGetRequestBuilder
public class MultiGetRequestBuilder extends ActionRequestBuilder<MultiGetRequest,MultiGetResponse>
A multi get document action request builder.
-
Field Summary
Fields inherited from class org.elasticsearch.action.ActionRequestBuilder
action, client, request
-
Constructor Summary
Constructors Constructor Description MultiGetRequestBuilder(ElasticsearchClient client, MultiGetAction action)
-
Method Summary
Modifier and Type Method Description MultiGetRequestBuilder
add(java.lang.String index, java.lang.String type, java.lang.Iterable<java.lang.String> ids)
MultiGetRequestBuilder
add(java.lang.String index, java.lang.String type, java.lang.String id)
MultiGetRequestBuilder
add(java.lang.String index, java.lang.String type, java.lang.String... ids)
MultiGetRequestBuilder
add(MultiGetRequest.Item item)
MultiGetRequestBuilder
setPreference(java.lang.String preference)
Sets the preference to execute the search.MultiGetRequestBuilder
setRealtime(boolean realtime)
MultiGetRequestBuilder
setRefresh(boolean refresh)
Should a refresh be executed before this get operation causing the operation to return the latest value.Methods inherited from class org.elasticsearch.action.ActionRequestBuilder
execute, execute, get, get, get, request
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Constructor Details
-
MultiGetRequestBuilder
-
-
Method Details
-
add
public MultiGetRequestBuilder add(java.lang.String index, @Nullable java.lang.String type, java.lang.String id) -
add
public MultiGetRequestBuilder add(java.lang.String index, @Nullable java.lang.String type, java.lang.Iterable<java.lang.String> ids) -
add
public MultiGetRequestBuilder add(java.lang.String index, @Nullable java.lang.String type, java.lang.String... ids) -
add
-
setPreference
Sets the preference to execute the search. Defaults to randomize across shards. Can be set to_local
to prefer local shards or a custom value, which guarantees that the same order will be used across different requests. -
setRefresh
Should a refresh be executed before this get operation causing the operation to return the latest value. Note, heavy get should not set this totrue
. Defaults tofalse
. -
setRealtime
-