org.elasticsearch.action.search

Class MultiSearchRequest

java.lang.Object

org.elasticsearch.common.ContextAndHeaderHolder

org.elasticsearch.transport.TransportMessage<TransportRequest>

org.elasticsearch.transport.TransportRequest

org.elasticsearch.action.ActionRequest<MultiSearchRequest>

org.elasticsearch.action.search.MultiSearchRequest

All Implemented Interfaces:

CompositeIndicesRequest, HasContext, HasContextAndHeaders, HasHeaders, Streamable

public class MultiSearchRequest
extends ActionRequest<MultiSearchRequest>
implements CompositeIndicesRequest

A multi search API request.

Nested Class Summary

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

TransportRequest.Empty

Field Summary

Fields inherited from class org.elasticsearch.common.ContextAndHeaderHolder

headers

Constructor Summary

Constructors

Constructor and Description
MultiSearchRequest()

Method Summary

Methods

Modifier and Type	Method and Description
MultiSearchRequest	add(byte[] data, int from, int length, boolean isTemplateRequest, String[] indices, String[] types, String searchType)
MultiSearchRequest	add(BytesReference data, boolean isTemplateRequest, String[] indices, String[] types, String searchType, IndicesOptions indicesOptions)
MultiSearchRequest	add(BytesReference data, boolean isTemplateRequest, String[] indices, String[] types, String searchType, String routing, IndicesOptions indicesOptions, boolean allowExplicitIndex)
MultiSearchRequest	add(SearchRequest request) Add a search request to execute.
MultiSearchRequest	add(SearchRequestBuilder request) Add a search request to execute.
IndicesOptions	indicesOptions()
MultiSearchRequest	indicesOptions(IndicesOptions indicesOptions)
void	readFrom(StreamInput in)
List<SearchRequest>	requests()
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

Constructor Detail

MultiSearchRequest

public MultiSearchRequest()

Method Detail

add

public MultiSearchRequest add(SearchRequestBuilder request)

Add a search request to execute. Note, the order is important, the search response will be returned in the same order as the search requests.

add

public MultiSearchRequest add(SearchRequest request)

Add a search request to execute. Note, the order is important, the search response will be returned in the same order as the search requests.

add

public MultiSearchRequest add(byte[] data,
                     int from,
                     int length,
                     boolean isTemplateRequest,
                     @Nullable
                     String[] indices,
                     @Nullable
                     String[] types,
                     @Nullable
                     String searchType)
                       throws Exception

Throws:

Exception

add

public MultiSearchRequest add(BytesReference data,
                     boolean isTemplateRequest,
                     @Nullable
                     String[] indices,
                     @Nullable
                     String[] types,
                     @Nullable
                     String searchType,
                     IndicesOptions indicesOptions)
                       throws Exception

Throws:

Exception

add

public MultiSearchRequest add(BytesReference data,
                     boolean isTemplateRequest,
                     @Nullable
                     String[] indices,
                     @Nullable
                     String[] types,
                     @Nullable
                     String searchType,
                     @Nullable
                     String routing,
                     IndicesOptions indicesOptions,
                     boolean allowExplicitIndex)
                       throws Exception

Throws:

Exception

requests

public List<SearchRequest> requests()

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

validate

public ActionRequestValidationException validate()

Specified by:

validate in class ActionRequest<MultiSearchRequest>

indicesOptions

public IndicesOptions indicesOptions()

indicesOptions

public MultiSearchRequest indicesOptions(IndicesOptions indicesOptions)

readFrom

public void readFrom(StreamInput in)
              throws IOException

Specified by:

readFrom in interface Streamable

Overrides:

readFrom in class ActionRequest<MultiSearchRequest>

Throws:

IOException

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Streamable

Overrides:

writeTo in class ActionRequest<MultiSearchRequest>

Throws:

IOException