public class MultiGetRequest extends ActionRequest<MultiGetRequest> implements java.lang.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 |
Constructor and Description |
---|
MultiGetRequest() |
Modifier and Type | Method and Description |
---|---|
MultiGetRequest |
add(MultiGetRequest.Item item) |
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,
byte[] data,
int from,
int length) |
MultiGetRequest |
add(java.lang.String defaultIndex,
java.lang.String defaultType,
java.lang.String[] defaultFields,
FetchSourceContext defaultFetchSource,
BytesReference data) |
MultiGetRequest |
add(java.lang.String defaultIndex,
java.lang.String defaultType,
java.lang.String[] defaultFields,
FetchSourceContext defaultFetchSource,
BytesReference data,
boolean allowExplicitIndex) |
MultiGetRequest |
add(java.lang.String defaultIndex,
java.lang.String defaultType,
java.lang.String[] defaultFields,
FetchSourceContext defaultFetchSource,
java.lang.String defaultRouting,
BytesReference data,
boolean allowExplicitIndex) |
java.util.List<MultiGetRequest.Item> |
getItems() |
MultiGetRequest |
ignoreErrorsOnGeneratedFields(boolean ignoreErrorsOnGeneratedFields) |
java.util.Iterator<MultiGetRequest.Item> |
iterator() |
static void |
parseDocuments(XContentParser parser,
java.util.List<MultiGetRequest.Item> items) |
static void |
parseDocuments(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,
boolean allowExplicitIndex) |
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(java.lang.Boolean realtime) |
boolean |
refresh() |
MultiGetRequest |
refresh(boolean refresh) |
java.util.List<? extends IndicesRequest> |
subRequests()
Returns the subrequests that a composite request is composed of
|
ActionRequestValidationException |
validate() |
void |
writeTo(StreamOutput out)
Write this object's fields to a StreamOutput.
|
createTask, getDescription
remoteAddress, remoteAddress
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<MultiGetRequest>
public java.util.List<? extends IndicesRequest> subRequests()
CompositeIndicesRequest
subRequests
in interface CompositeIndicesRequest
public MultiGetRequest preference(java.lang.String preference)
public java.lang.String preference()
public boolean realtime()
public MultiGetRequest realtime(java.lang.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 java.lang.String defaultIndex, @Nullable java.lang.String defaultType, @Nullable java.lang.String[] defaultFields, @Nullable FetchSourceContext defaultFetchSource, byte[] data, int from, int length) throws java.lang.Exception
java.lang.Exception
public MultiGetRequest add(@Nullable java.lang.String defaultIndex, @Nullable java.lang.String defaultType, @Nullable java.lang.String[] defaultFields, @Nullable FetchSourceContext defaultFetchSource, BytesReference data) throws java.lang.Exception
java.lang.Exception
public MultiGetRequest add(@Nullable java.lang.String defaultIndex, @Nullable java.lang.String defaultType, @Nullable java.lang.String[] defaultFields, @Nullable FetchSourceContext defaultFetchSource, BytesReference data, boolean allowExplicitIndex) throws java.lang.Exception
java.lang.Exception
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, BytesReference data, boolean allowExplicitIndex) throws java.lang.Exception
java.lang.Exception
public static void parseDocuments(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, boolean allowExplicitIndex) throws java.io.IOException
java.io.IOException
public static void parseDocuments(XContentParser parser, java.util.List<MultiGetRequest.Item> items) 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<MultiGetRequest>
java.io.IOException
public void writeTo(StreamOutput out) throws java.io.IOException
Streamable
writeTo
in interface Streamable
writeTo
in class ActionRequest<MultiGetRequest>
java.io.IOException