public class MultiGetRequest extends ActionRequest<MultiGetRequest> implements Iterable<MultiGetRequest.Item>, CompositeIndicesRequest, RealtimeRequest
Modifier and Type | Class and Description |
---|---|
static class |
MultiGetRequest.Item
A single get item.
|
TransportRequest.Empty
Modifier and Type | Field and Description |
---|---|
boolean |
ignoreErrorsOnGeneratedFields |
headers
Constructor and Description |
---|
MultiGetRequest() |
MultiGetRequest(ActionRequest request)
Creates a multi get request caused by some other request, which is provided as an
argument so that its headers and context can be copied to the new request
|
Modifier and Type | Method and Description |
---|---|
MultiGetRequest |
add(MultiGetRequest.Item item) |
MultiGetRequest |
add(String index,
String type,
String id) |
MultiGetRequest |
add(String defaultIndex,
String defaultType,
String[] defaultFields,
FetchSourceContext defaultFetchSource,
byte[] data,
int from,
int length) |
MultiGetRequest |
add(String defaultIndex,
String defaultType,
String[] defaultFields,
FetchSourceContext defaultFetchSource,
BytesReference data) |
MultiGetRequest |
add(String defaultIndex,
String defaultType,
String[] defaultFields,
FetchSourceContext defaultFetchSource,
BytesReference data,
boolean allowExplicitIndex) |
MultiGetRequest |
add(String defaultIndex,
String defaultType,
String[] defaultFields,
FetchSourceContext defaultFetchSource,
String defaultRouting,
BytesReference data,
boolean allowExplicitIndex) |
List<MultiGetRequest.Item> |
getItems() |
MultiGetRequest |
ignoreErrorsOnGeneratedFields(boolean ignoreErrorsOnGeneratedFields) |
Iterator<MultiGetRequest.Item> |
iterator() |
static void |
parseDocuments(XContentParser parser,
List<MultiGetRequest.Item> items) |
static void |
parseDocuments(XContentParser parser,
List<MultiGetRequest.Item> items,
String defaultIndex,
String defaultType,
String[] defaultFields,
FetchSourceContext defaultFetchSource,
String defaultRouting,
boolean allowExplicitIndex) |
static void |
parseIds(XContentParser parser,
List<MultiGetRequest.Item> items) |
static void |
parseIds(XContentParser parser,
List<MultiGetRequest.Item> items,
String defaultIndex,
String defaultType,
String[] defaultFields,
FetchSourceContext defaultFetchSource,
String defaultRouting) |
String |
preference() |
MultiGetRequest |
preference(String preference)
Sets the preference to execute the search.
|
void |
readFrom(StreamInput in) |
boolean |
realtime() |
MultiGetRequest |
realtime(Boolean realtime) |
boolean |
refresh() |
MultiGetRequest |
refresh(boolean refresh) |
List<? extends IndicesRequest> |
subRequests()
Returns the subrequests that a composite request is composed of
|
ActionRequestValidationException |
validate() |
void |
writeTo(StreamOutput out) |
createTask, getDescription
remoteAddress, remoteAddress
contextSize, copyContextAndHeadersFrom, copyContextFrom, copyHeadersFrom, getContext, getFromContext, getFromContext, getHeader, getHeaders, hasHeader, hasInContext, isContextEmpty, putAllInContext, putHeader, putInContext
public MultiGetRequest()
public MultiGetRequest(ActionRequest request)
public List<MultiGetRequest.Item> getItems()
public MultiGetRequest add(MultiGetRequest.Item item)
public MultiGetRequest add(String index, @Nullable String type, String id)
public ActionRequestValidationException validate()
validate
in class ActionRequest<MultiGetRequest>
public List<? extends IndicesRequest> subRequests()
CompositeIndicesRequest
subRequests
in interface CompositeIndicesRequest
public MultiGetRequest preference(String preference)
public String preference()
public boolean realtime()
public MultiGetRequest realtime(Boolean realtime)
realtime
in interface RealtimeRequest
realtime
- Controls whether this request should be realtime by reading from the translog. If null
is specified then whether the operation will be realtime depends on the api of the concrete request
subclass.public boolean refresh()
public MultiGetRequest refresh(boolean refresh)
public MultiGetRequest ignoreErrorsOnGeneratedFields(boolean ignoreErrorsOnGeneratedFields)
public MultiGetRequest add(@Nullable String defaultIndex, @Nullable String defaultType, @Nullable String[] defaultFields, @Nullable FetchSourceContext defaultFetchSource, byte[] data, int from, int length) throws Exception
Exception
public MultiGetRequest add(@Nullable String defaultIndex, @Nullable String defaultType, @Nullable String[] defaultFields, @Nullable FetchSourceContext defaultFetchSource, BytesReference data) throws Exception
Exception
public MultiGetRequest add(@Nullable String defaultIndex, @Nullable String defaultType, @Nullable String[] defaultFields, @Nullable FetchSourceContext defaultFetchSource, BytesReference data, boolean allowExplicitIndex) throws Exception
Exception
public MultiGetRequest add(@Nullable String defaultIndex, @Nullable String defaultType, @Nullable String[] defaultFields, @Nullable FetchSourceContext defaultFetchSource, @Nullable String defaultRouting, BytesReference data, boolean allowExplicitIndex) throws Exception
Exception
public static void parseDocuments(XContentParser parser, List<MultiGetRequest.Item> items, @Nullable String defaultIndex, @Nullable String defaultType, @Nullable String[] defaultFields, @Nullable FetchSourceContext defaultFetchSource, @Nullable String defaultRouting, boolean allowExplicitIndex) throws IOException
IOException
public static void parseDocuments(XContentParser parser, List<MultiGetRequest.Item> items) throws IOException
IOException
public static void parseIds(XContentParser parser, List<MultiGetRequest.Item> items, @Nullable String defaultIndex, @Nullable String defaultType, @Nullable String[] defaultFields, @Nullable FetchSourceContext defaultFetchSource, @Nullable String defaultRouting) throws IOException
IOException
public static void parseIds(XContentParser parser, List<MultiGetRequest.Item> items) throws IOException
IOException
public Iterator<MultiGetRequest.Item> iterator()
iterator
in interface Iterable<MultiGetRequest.Item>
public void readFrom(StreamInput in) throws IOException
readFrom
in interface Streamable
readFrom
in class ActionRequest<MultiGetRequest>
IOException
public void writeTo(StreamOutput out) throws IOException
writeTo
in interface Streamable
writeTo
in class ActionRequest<MultiGetRequest>
IOException
Copyright © 2009–2016. All rights reserved.