org.elasticsearch.action.search
Class SearchRequest

java.lang.Object
  org.elasticsearch.action.search.SearchRequest

All Implemented Interfaces:

ActionRequest, Streamable

public class SearchRequest
extends java.lang.Object
implements ActionRequest

A request to execute search against one or more indices (or all). Best created using Requests.searchRequest(String...).

Note, the search source(org.elasticsearch.search.builder.SearchSourceBuilder) is required. The search source is the different search options, including facets and such.

There is an option to specify an addition search source using the extraSource(org.elasticsearch.search.builder.SearchSourceBuilder).

See Also:

Requests.searchRequest(String...), Client.search(SearchRequest), SearchResponse

Constructor Summary

SearchRequest(java.lang.String... indices)
Constructs a new search request against the indices.

SearchRequest(java.lang.String[] indices, byte[] source)
Constructs a new search request against the provided indices with the given search source.

Method Summary

byte[]	extraSource() Additional search source to execute.
SearchRequest	extraSource(byte[] source) Allows to provide additional source that will be used as well.
SearchRequest	extraSource(SearchSourceBuilder sourceBuilder) Allows to provide additional source that will be used as well.
SearchRequest	extraSource(java.lang.String source) Allows to provide additional source that will use used as well.
java.lang.String[]	indices() The indices
SearchRequest	indices(java.lang.String[] indices) Sets the indices the search will be executed on.
boolean	listenerThreaded() Should the listener be called on a separate thread if needed.
SearchRequest	listenerThreaded(boolean listenerThreaded) Should the listener be called on a separate thread if needed.
SearchOperationThreading	operationThreading() Controls the the search operation threading model.
SearchRequest	operationThreading(SearchOperationThreading operationThreading) Controls the the search operation threading model.
java.lang.String	queryHint() A query hint to optionally later be used when routing the request.
SearchRequest	queryHint(java.lang.String queryHint) A query hint to optionally later be used when routing the request.
void	readFrom(StreamInput in)
Scroll	scroll() If set, will enable scrolling of the search request.
SearchRequest	scroll(Scroll scroll) If set, will enable scrolling of the search request.
SearchRequest	scroll(TimeValue keepAlive) If set, will enable scrolling of the search request for the specified timeout.
SearchType	searchType() The tye of search to execute.
SearchRequest	searchType(SearchType searchType) The search type to execute, defaults to SearchType.DEFAULT.
byte[]	source() The search source to execute.
SearchRequest	source(byte[] source) The search source to execute.
SearchRequest	source(SearchSourceBuilder sourceBuilder) The source of the search request.
SearchRequest	source(java.lang.String source) The source of the search request.
TimeValue	timeout() An optional timeout to control how long search is allowed to take.
SearchRequest	timeout(TimeValue timeout) An optional timeout to control how long search is allowed to take.
java.lang.String[]	types() The document types to execute the search against.
SearchRequest	types(java.lang.String... types) The document types to execute the search against.
ActionRequestValidationException	validate()
void	writeTo(StreamOutput out)

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchRequest

public SearchRequest(java.lang.String... indices)

Constructs a new search request against the indices. No indices provided here means that search will run against all indices.

SearchRequest

public SearchRequest(java.lang.String[] indices,
                     byte[] source)

Constructs a new search request against the provided indices with the given search source.

Method Detail

validate

public ActionRequestValidationException validate()

Specified by:

validate in interface ActionRequest

listenerThreaded

public boolean listenerThreaded()

Should the listener be called on a separate thread if needed.

Specified by:

listenerThreaded in interface ActionRequest

indices

public SearchRequest indices(java.lang.String[] indices)

Sets the indices the search will be executed on.

listenerThreaded

public SearchRequest listenerThreaded(boolean listenerThreaded)

Should the listener be called on a separate thread if needed.

Specified by:

listenerThreaded in interface ActionRequest

operationThreading

public SearchOperationThreading operationThreading()

Controls the the search operation threading model.

operationThreading

public SearchRequest operationThreading(SearchOperationThreading operationThreading)

Controls the the search operation threading model.

types

public java.lang.String[] types()

The document types to execute the search against. Defaults to be executed against all types.

types

public SearchRequest types(java.lang.String... types)

The document types to execute the search against. Defaults to be executed against all types.

searchType

public SearchRequest searchType(SearchType searchType)

The search type to execute, defaults to SearchType.DEFAULT.

source

public SearchRequest source(SearchSourceBuilder sourceBuilder)

The source of the search request.

source

public SearchRequest source(java.lang.String source)

The source of the search request. Consider using either source(byte[]) or source(org.elasticsearch.search.builder.SearchSourceBuilder).

source

public SearchRequest source(byte[] source)

The search source to execute.

source

public byte[] source()

The search source to execute.

extraSource

public SearchRequest extraSource(SearchSourceBuilder sourceBuilder)

Allows to provide additional source that will be used as well.

extraSource

public SearchRequest extraSource(java.lang.String source)

Allows to provide additional source that will use used as well.

extraSource

public SearchRequest extraSource(byte[] source)

Allows to provide additional source that will be used as well.

extraSource

public byte[] extraSource()

Additional search source to execute.

searchType

public SearchType searchType()

The tye of search to execute.

indices

public java.lang.String[] indices()

The indices

queryHint

public SearchRequest queryHint(java.lang.String queryHint)

A query hint to optionally later be used when routing the request.

queryHint

public java.lang.String queryHint()

A query hint to optionally later be used when routing the request.

scroll

public Scroll scroll()

If set, will enable scrolling of the search request.

scroll

public SearchRequest scroll(Scroll scroll)

If set, will enable scrolling of the search request.

scroll

public SearchRequest scroll(TimeValue keepAlive)

If set, will enable scrolling of the search request for the specified timeout.

timeout

public TimeValue timeout()

An optional timeout to control how long search is allowed to take.

timeout

public SearchRequest timeout(TimeValue timeout)

An optional timeout to control how long search is allowed to take.

readFrom

public void readFrom(StreamInput in)
              throws java.io.IOException

Specified by:

readFrom in interface Streamable

Throws:

java.io.IOException

writeTo

public void writeTo(StreamOutput out)
             throws java.io.IOException

Specified by:

writeTo in interface Streamable

Throws:

java.io.IOException