org.elasticsearch.action.search

Class SearchRequest

java.lang.Object

org.elasticsearch.common.ContextAndHeaderHolder

org.elasticsearch.transport.TransportMessage<TransportRequest>

org.elasticsearch.transport.TransportRequest

org.elasticsearch.action.ActionRequest<SearchRequest>

org.elasticsearch.action.search.SearchRequest

All Implemented Interfaces:

IndicesRequest, IndicesRequest.Replaceable, HasContext, HasContextAndHeaders, HasHeaders, Streamable

public class SearchRequest
extends ActionRequest<SearchRequest>
implements IndicesRequest.Replaceable

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 aggregations 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

Nested Class Summary

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

TransportRequest.Empty

Nested classes/interfaces inherited from interface org.elasticsearch.action.IndicesRequest

IndicesRequest.Replaceable

Field Summary

Fields

Modifier and Type	Field and Description
static IndicesOptions	DEFAULT_INDICES_OPTIONS

Fields inherited from class org.elasticsearch.common.ContextAndHeaderHolder

headers

Constructor Summary

Constructors

Constructor and Description
SearchRequest()
SearchRequest(ActionRequest request) Constructs a new search request starting from the provided request, meaning that it will inherit its headers and context
SearchRequest(SearchRequest searchRequest, ActionRequest originalRequest) Copy constructor that creates a new search request that is a copy of the one provided as an argument.
SearchRequest(String... indices) Constructs a new search request against the indices.
SearchRequest(String[] indices, byte[] source) Constructs a new search request against the provided indices with the given search source.

Method Summary

Modifier and Type	Method and Description
BytesReference	extraSource() Additional search source to execute.
SearchRequest	extraSource(byte[] source) Allows to provide additional source that will be used as well.
SearchRequest	extraSource(byte[] source, int offset, int length) Allows to provide additional source that will be used as well.
SearchRequest	extraSource(BytesReference source) Allows to provide additional source that will be used as well.
SearchRequest	extraSource(Map extraSource)
SearchRequest	extraSource(SearchSourceBuilder sourceBuilder) Allows to provide additional source that will be used as well.
SearchRequest	extraSource(String source) Allows to provide additional source that will use used as well.
SearchRequest	extraSource(XContentBuilder builder)
String[]	indices() The indices
SearchRequest	indices(String... indices) Sets the indices the search will be executed on.
IndicesOptions	indicesOptions() Returns the indices options used to resolve indices.
SearchRequest	indicesOptions(IndicesOptions indicesOptions)
String	preference()
SearchRequest	preference(String preference) Sets the preference to execute the search.
void	readFrom(StreamInput in)
Boolean	requestCache()
SearchRequest	requestCache(Boolean requestCache) Sets if this request should use the request cache or not, assuming that it can (for example, if "now" is used, it will never be cached).
String	routing() A comma separated list of routing values to control the shards the search will be executed on.
SearchRequest	routing(String... routings) The routing values to control the shards that the search will be executed on.
SearchRequest	routing(String routing) A comma separated list of routing values to control the shards the search will be executed on.
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(String keepAlive) If set, will enable scrolling of the search request for the specified timeout.
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.
SearchRequest	searchType(String searchType) The a string representation search type to execute, defaults to SearchType.DEFAULT.
BytesReference	source() The search source to execute.
SearchRequest	source(byte[] source) The search source to execute.
SearchRequest	source(byte[] source, int offset, int length) The search source to execute.
SearchRequest	source(BytesReference source) The search source to execute.
SearchRequest	source(Map source) The source of the search request in the form of a map.
SearchRequest	source(SearchSourceBuilder sourceBuilder) The source of the search request.
SearchRequest	source(String source) The source of the search request.
SearchRequest	source(XContentBuilder builder)
Template	template() The stored template
void	template(Template template) The stored template
String	templateName() Deprecated. use template() instead.
void	templateName(String templateName) Deprecated. use template(Template) instead.
Map<String,Object>	templateParams() Deprecated. use template() instead.
void	templateParams(Map<String,Object> params) Deprecated. use template(Template) instead.
BytesReference	templateSource() The search source template to execute.
SearchRequest	templateSource(BytesReference template) Allows to provide template as source.
SearchRequest	templateSource(String template) The template of the search request.
ScriptService.ScriptType	templateType() Deprecated. use template() instead.
void	templateType(ScriptService.ScriptType templateType) Deprecated. use template(Template) instead.
String[]	types() The document types to execute the search against.
SearchRequest	types(String... types) The document types to execute the search against.
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

DEFAULT_INDICES_OPTIONS

public static final IndicesOptions DEFAULT_INDICES_OPTIONS

Constructor Detail

SearchRequest

public SearchRequest()

SearchRequest

public SearchRequest(SearchRequest searchRequest,
                     ActionRequest originalRequest)

Copy constructor that creates a new search request that is a copy of the one provided as an argument. The new request will inherit though headers and context from the original request that caused it.

SearchRequest

public SearchRequest(ActionRequest request)

Constructs a new search request starting from the provided request, meaning that it will inherit its headers and context

SearchRequest

public SearchRequest(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(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 class ActionRequest<SearchRequest>

indices

public SearchRequest indices(String... indices)

Sets the indices the search will be executed on.

Specified by:

indices in interface IndicesRequest.Replaceable

indicesOptions

public IndicesOptions indicesOptions()

Description copied from interface: IndicesRequest

Returns the indices options used to resolve indices. They tell for instance whether a single index is accepted, whether an empty array will be converted to _all, and how wildcards will be expanded if needed.

Specified by:

indicesOptions in interface IndicesRequest

indicesOptions

public SearchRequest indicesOptions(IndicesOptions indicesOptions)

types

public String[] types()

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

types

public SearchRequest types(String... types)

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

routing

public String routing()

A comma separated list of routing values to control the shards the search will be executed on.

routing

public SearchRequest routing(String routing)

A comma separated list of routing values to control the shards the search will be executed on.

routing

public SearchRequest routing(String... routings)

The routing values to control the shards that the search will be executed on.

preference

public SearchRequest 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()

searchType

public SearchRequest searchType(SearchType searchType)

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

searchType

public SearchRequest searchType(String searchType)

The a string representation search type to execute, defaults to SearchType.DEFAULT. Can be one of "dfs_query_then_fetch"/"dfsQueryThenFetch", "dfs_query_and_fetch"/"dfsQueryAndFetch", "query_then_fetch"/"queryThenFetch", and "query_and_fetch"/"queryAndFetch".

source

public SearchRequest source(SearchSourceBuilder sourceBuilder)

The source of the search request.

source

public SearchRequest source(String source)

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

source

public SearchRequest source(Map source)

The source of the search request in the form of a map.

source

public SearchRequest source(XContentBuilder builder)

source

public SearchRequest source(byte[] source)

The search source to execute.

source

public SearchRequest source(byte[] source,
                            int offset,
                            int length)

The search source to execute.

source

public SearchRequest source(BytesReference source)

The search source to execute.

source

public BytesReference source()

The search source to execute.

templateSource

public BytesReference templateSource()

The search source template to execute.

extraSource

public SearchRequest extraSource(SearchSourceBuilder sourceBuilder)

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

extraSource

public SearchRequest extraSource(Map extraSource)

extraSource

public SearchRequest extraSource(XContentBuilder builder)

extraSource

public SearchRequest extraSource(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 SearchRequest extraSource(byte[] source,
                                 int offset,
                                 int length)

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

extraSource

public SearchRequest extraSource(BytesReference source)

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

templateSource

public SearchRequest templateSource(BytesReference template)

Allows to provide template as source.

templateSource

public SearchRequest templateSource(String template)

The template of the search request.

template

public void template(Template template)

The stored template

template

public Template template()

The stored template

templateName

@Deprecated
public void templateName(String templateName)

Deprecated. use template(Template) instead.

The name of the stored template

templateType

@Deprecated
public void templateType(ScriptService.ScriptType templateType)

Deprecated. use template(Template) instead.

The type of the stored template

templateParams

@Deprecated
public void templateParams(Map<String,Object> params)

Deprecated. use template(Template) instead.

Template parameters used for rendering

templateName

@Deprecated
public String templateName()

Deprecated. use template() instead.

The name of the stored template

templateType

@Deprecated
public ScriptService.ScriptType templateType()

Deprecated. use template() instead.

The name of the stored template

templateParams

@Deprecated
public Map<String,Object> templateParams()

Deprecated. use template() instead.

Template parameters used for rendering

extraSource

public BytesReference extraSource()

Additional search source to execute.

searchType

public SearchType searchType()

The tye of search to execute.

indices

public String[] indices()

The indices

Specified by:

indices in interface IndicesRequest

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.

scroll

public SearchRequest scroll(String keepAlive)

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

requestCache

public SearchRequest requestCache(Boolean requestCache)

Sets if this request should use the request cache or not, assuming that it can (for example, if "now" is used, it will never be cached). By default (not set, or null, will default to the index level setting if request cache is enabled or not).

requestCache

public Boolean requestCache()

readFrom

public void readFrom(StreamInput in)
              throws IOException

Specified by:

readFrom in interface Streamable

Overrides:

readFrom in class ActionRequest<SearchRequest>

Throws:

IOException

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Streamable

Overrides:

writeTo in class ActionRequest<SearchRequest>

Throws:

IOException