java.lang.Iterable<MultiGetRequest.Item>
, CompositeIndicesRequest
, RealtimeRequest
, Streamable
, Writeable
, ToXContent
, ToXContentObject
, TaskAwareRequest
public class MultiGetRequest extends ActionRequest implements java.lang.Iterable<MultiGetRequest.Item>, CompositeIndicesRequest, RealtimeRequest, ToXContentObject
Modifier and Type | Class | Description |
---|---|---|
static class |
MultiGetRequest.Item |
A single get item.
|
ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params
TransportRequest.Empty
Writeable.Reader<V>, Writeable.Writer<V>
EMPTY_PARAMS
Constructor | Description |
---|---|
MultiGetRequest() |
Modifier and Type | Method | Description |
---|---|---|
MultiGetRequest |
add(java.lang.String index,
java.lang.String type,
java.lang.String id) |
|
MultiGetRequest |
add(java.lang.String defaultIndex,
java.lang.String defaultType,
java.lang.String[] defaultFields,
FetchSourceContext defaultFetchSource,
java.lang.String defaultRouting,
XContentParser parser,
boolean allowExplicitIndex) |
|
MultiGetRequest |
add(MultiGetRequest.Item item) |
|
java.util.List<MultiGetRequest.Item> |
getItems() |
|
java.util.Iterator<MultiGetRequest.Item> |
iterator() |
|
static void |
parseIds(XContentParser parser,
java.util.List<MultiGetRequest.Item> items) |
|
static void |
parseIds(XContentParser parser,
java.util.List<MultiGetRequest.Item> items,
java.lang.String defaultIndex,
java.lang.String defaultType,
java.lang.String[] defaultFields,
FetchSourceContext defaultFetchSource,
java.lang.String defaultRouting) |
|
java.lang.String |
preference() |
|
MultiGetRequest |
preference(java.lang.String preference) |
Sets the preference to execute the search.
|
void |
readFrom(StreamInput in) |
Set this object's fields from a StreamInput.
|
boolean |
realtime() |
|
MultiGetRequest |
realtime(boolean realtime) |
|
boolean |
refresh() |
|
MultiGetRequest |
refresh(boolean refresh) |
|
XContentBuilder |
toXContent(XContentBuilder builder,
ToXContent.Params params) |
|
ActionRequestValidationException |
validate() |
|
void |
writeTo(StreamOutput out) |
Write this object's fields to a StreamOutput.
|
getShouldStoreResult
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
createTask, getDescription, setParentTask
isFragment
remoteAddress, remoteAddress
getParentTask, setParentTask
public java.util.List<MultiGetRequest.Item> getItems()
public MultiGetRequest add(MultiGetRequest.Item item)
public MultiGetRequest add(java.lang.String index, @Nullable java.lang.String type, java.lang.String id)
public ActionRequestValidationException validate()
validate
in class ActionRequest
public MultiGetRequest preference(java.lang.String preference)
public java.lang.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.public boolean refresh()
public MultiGetRequest refresh(boolean refresh)
public MultiGetRequest add(@Nullable java.lang.String defaultIndex, @Nullable java.lang.String defaultType, @Nullable java.lang.String[] defaultFields, @Nullable FetchSourceContext defaultFetchSource, @Nullable java.lang.String defaultRouting, XContentParser parser, boolean allowExplicitIndex) throws java.io.IOException
java.io.IOException
public static void parseIds(XContentParser parser, java.util.List<MultiGetRequest.Item> items, @Nullable java.lang.String defaultIndex, @Nullable java.lang.String defaultType, @Nullable java.lang.String[] defaultFields, @Nullable FetchSourceContext defaultFetchSource, @Nullable java.lang.String defaultRouting) throws java.io.IOException
java.io.IOException
public static void parseIds(XContentParser parser, java.util.List<MultiGetRequest.Item> items) throws java.io.IOException
java.io.IOException
public java.util.Iterator<MultiGetRequest.Item> iterator()
iterator
in interface java.lang.Iterable<MultiGetRequest.Item>
public void readFrom(StreamInput in) throws java.io.IOException
Streamable
readFrom
in interface Streamable
readFrom
in class ActionRequest
java.io.IOException
public void writeTo(StreamOutput out) throws java.io.IOException
Streamable
writeTo
in interface Streamable
writeTo
in interface Writeable
writeTo
in class ActionRequest
java.io.IOException
public XContentBuilder toXContent(XContentBuilder builder, ToXContent.Params params) throws java.io.IOException
toXContent
in interface ToXContent
java.io.IOException