Module org.elasticsearch.server

Package org.elasticsearch.action.get

Class MultiGetRequestBuilder

java.lang.Object

org.elasticsearch.action.ActionRequestBuilder<MultiGetRequest,MultiGetResponse>

org.elasticsearch.action.get.MultiGetRequestBuilder

All Implemented Interfaces:

RequestBuilder<MultiGetRequest,MultiGetResponse>

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)

Method Summary

Modifier and Type	Method	Description
MultiGetRequestBuilder	add(String index, String id)
MultiGetRequestBuilder	add(MultiGetRequest.Item item)
MultiGetRequestBuilder	addIds(String index, Iterable<String> ids)
MultiGetRequestBuilder	addIds(String index, String... ids)
MultiGetRequestBuilder	setPreference(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, request

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

MultiGetRequestBuilder

public MultiGetRequestBuilder(ElasticsearchClient client)

Method Details

add

public MultiGetRequestBuilder add(String index,
 String id)

addIds

public MultiGetRequestBuilder addIds(String index,
 Iterable<String> ids)

addIds

public MultiGetRequestBuilder addIds(String index,
 String... ids)

add

public MultiGetRequestBuilder add(MultiGetRequest.Item item)

setPreference

public MultiGetRequestBuilder setPreference(String preference)

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

public MultiGetRequestBuilder setRefresh(boolean refresh)

Should a refresh be executed before this get operation causing the operation to return the latest value. Note, heavy get should not set this to true. Defaults to false.

setRealtime

public MultiGetRequestBuilder setRealtime(boolean realtime)