org.elasticsearch.action.get

Class MultiGetRequest

java.lang.Object

org.elasticsearch.common.ContextAndHeaderHolder

org.elasticsearch.transport.TransportMessage<TransportRequest>

org.elasticsearch.transport.TransportRequest

org.elasticsearch.action.ActionRequest<MultiGetRequest>

org.elasticsearch.action.get.MultiGetRequest

All Implemented Interfaces:

Iterable<MultiGetRequest.Item>, CompositeIndicesRequest, RealtimeRequest, HasContext, HasContextAndHeaders, HasHeaders, Streamable

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

Nested Class Summary

Nested Classes

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

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

TransportRequest.Empty

Field Summary

Fields

Modifier and Type	Field and Description
boolean	ignoreErrorsOnGeneratedFields

Fields inherited from class org.elasticsearch.common.ContextAndHeaderHolder

headers

Constructor Summary

Constructors

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

Method Summary

Methods

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)

Methods inherited from class org.elasticsearch.transport.TransportRequest

createTask, getDescription

Methods inherited from class org.elasticsearch.transport.TransportMessage

remoteAddress, remoteAddress

Methods inherited from class org.elasticsearch.common.ContextAndHeaderHolder

contextSize, copyContextAndHeadersFrom, copyContextFrom, copyHeadersFrom, getContext, getFromContext, getFromContext, getHeader, getHeaders, hasHeader, hasInContext, isContextEmpty, putAllInContext, putHeader, putInContext

Methods inherited from class java.lang.Object

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

Field Detail

ignoreErrorsOnGeneratedFields

public boolean ignoreErrorsOnGeneratedFields

Constructor Detail

MultiGetRequest

public MultiGetRequest()

MultiGetRequest

public 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

Method Detail

getItems

public List<MultiGetRequest.Item> getItems()

add

public MultiGetRequest add(MultiGetRequest.Item item)

add

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

validate

public ActionRequestValidationException validate()

Specified by:

validate in class ActionRequest<MultiGetRequest>

subRequests

public List<? extends IndicesRequest> subRequests()

Description copied from interface: CompositeIndicesRequest

Returns the subrequests that a composite request is composed of

Specified by:

subRequests in interface CompositeIndicesRequest

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, _primary to execute only on primary 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. If null is specified then whether the operation will be realtime depends on the api of the concrete request subclass.

refresh

public boolean refresh()

refresh

public MultiGetRequest refresh(boolean refresh)

ignoreErrorsOnGeneratedFields

public MultiGetRequest ignoreErrorsOnGeneratedFields(boolean ignoreErrorsOnGeneratedFields)

add

public MultiGetRequest add(@Nullable
                  String defaultIndex,
                  @Nullable
                  String defaultType,
                  @Nullable
                  String[] defaultFields,
                  @Nullable
                  FetchSourceContext defaultFetchSource,
                  byte[] data,
                  int from,
                  int length)
                    throws Exception

Throws:

Exception

add

public MultiGetRequest add(@Nullable
                  String defaultIndex,
                  @Nullable
                  String defaultType,
                  @Nullable
                  String[] defaultFields,
                  @Nullable
                  FetchSourceContext defaultFetchSource,
                  BytesReference data)
                    throws Exception

Throws:

Exception

add

public MultiGetRequest add(@Nullable
                  String defaultIndex,
                  @Nullable
                  String defaultType,
                  @Nullable
                  String[] defaultFields,
                  @Nullable
                  FetchSourceContext defaultFetchSource,
                  BytesReference data,
                  boolean allowExplicitIndex)
                    throws Exception

Throws:

Exception

add

public MultiGetRequest add(@Nullable
                  String defaultIndex,
                  @Nullable
                  String defaultType,
                  @Nullable
                  String[] defaultFields,
                  @Nullable
                  FetchSourceContext defaultFetchSource,
                  @Nullable
                  String defaultRouting,
                  BytesReference data,
                  boolean allowExplicitIndex)
                    throws Exception

Throws:

Exception

parseDocuments

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

Throws:

IOException

parseDocuments

public static void parseDocuments(XContentParser parser,
                  List<MultiGetRequest.Item> items)
                           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

parseIds

public static void parseIds(XContentParser parser,
            List<MultiGetRequest.Item> items)
                     throws IOException

Throws:

IOException

iterator

public Iterator<MultiGetRequest.Item> iterator()

Specified by:

iterator in interface Iterable<MultiGetRequest.Item>

readFrom

public void readFrom(StreamInput in)
              throws IOException

Specified by:

readFrom in interface Streamable

Overrides:

readFrom in class ActionRequest<MultiGetRequest>

Throws:

IOException

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Streamable

Overrides:

writeTo in class ActionRequest<MultiGetRequest>

Throws:

IOException