Package org.elasticsearch.action.get

Class MultiGetRequest

java.lang.Object

org.elasticsearch.transport.TransportMessage

org.elasticsearch.transport.TransportRequest

org.elasticsearch.action.ActionRequest

org.elasticsearch.action.get.MultiGetRequest

All Implemented Interfaces:

Iterable<MultiGetRequest.Item>, CompositeIndicesRequest, RealtimeRequest, Writeable, RefCounted, TaskAwareRequest, ToXContent, ToXContentObject

public class MultiGetRequest
extends ActionRequest
implements Iterable<MultiGetRequest.Item>, CompositeIndicesRequest, RealtimeRequest, ToXContentObject

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MultiGetRequest.Item	A single get item.

Nested classes/interfaces inherited from class org.elasticsearch.transport.TransportRequest

TransportRequest.Empty

Nested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
MultiGetRequest()
MultiGetRequest(StreamInput in)

Method Summary

Modifier and Type	Method	Description
MultiGetRequest	add(String index, String id)
MultiGetRequest	add(String index, String type, String id)	Deprecated. Types are in the process of being removed, use add(String, String) instead.
MultiGetRequest	add(String defaultIndex, String defaultType, String[] defaultFields, FetchSourceContext defaultFetchSource, String defaultRouting, XContentParser parser, boolean allowExplicitIndex)
MultiGetRequest	add(MultiGetRequest.Item item)
List<MultiGetRequest.Item>	getItems()
Iterator<MultiGetRequest.Item>	iterator()
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.
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 into the StreamOutput.

Methods inherited from class org.elasticsearch.action.ActionRequest

getShouldStoreResult

Methods inherited from class org.elasticsearch.transport.TransportRequest

getParentTask, setParentTask, toString

Methods inherited from class org.elasticsearch.transport.TransportMessage

decRef, hasReferences, incRef, remoteAddress, remoteAddress, tryIncRef

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface org.elasticsearch.tasks.TaskAwareRequest

createTask, getDescription, setParentTask

Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject

isFragment

Constructor Details

MultiGetRequest

public MultiGetRequest()

MultiGetRequest

public MultiGetRequest(StreamInput in)
                throws IOException

Throws:

IOException

Method Details

getItems

public List<MultiGetRequest.Item> getItems()

add

public MultiGetRequest add(MultiGetRequest.Item item)

add

@Deprecated
public MultiGetRequest add(String index,
 @Nullable
 String type,
 String id)

Deprecated.

Types are in the process of being removed, use add(String, String) instead.

add

public MultiGetRequest add(String index,
 String id)

validate

public ActionRequestValidationException validate()

Specified by:

validate in class ActionRequest

preference

public MultiGetRequest preference(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.

preference

public String preference()

realtime

public boolean realtime()

realtime

public MultiGetRequest realtime(boolean realtime)

Specified by:

realtime in interface RealtimeRequest

Parameters:

realtime - Controls whether this request should be realtime by reading from the translog.

refresh

public boolean refresh()

refresh

public MultiGetRequest refresh(boolean refresh)

add

public MultiGetRequest add(@Nullable
 String defaultIndex,
 @Nullable
 String defaultType,
 @Nullable
 String[] defaultFields,
 @Nullable
 FetchSourceContext defaultFetchSource,
 @Nullable
 String defaultRouting,
 XContentParser parser,
 boolean allowExplicitIndex)
                    throws IOException

Throws:

IOException

parseIds

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

Throws:

IOException

iterator

public Iterator<MultiGetRequest.Item> iterator()

Specified by:

iterator in interface Iterable<MultiGetRequest.Item>

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Overrides:

writeTo in class ActionRequest

Throws:

IOException

toXContent

public XContentBuilder toXContent(XContentBuilder builder,
 ToXContent.Params params)
                           throws IOException

Specified by:

toXContent in interface ToXContent

Throws:

IOException