SearchRequestBuilder (elasticsearch 0.20.0.Beta1-SNAPSHOT API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.elasticsearch.action.search
Class SearchRequestBuilder

java.lang.Object
  org.elasticsearch.action.support.BaseRequestBuilder<SearchRequest,SearchResponse>
      org.elasticsearch.action.search.SearchRequestBuilder

All Implemented Interfaces:: ActionRequestBuilder<SearchRequest,SearchResponse>

public class SearchRequestBuilder
extends BaseRequestBuilder<SearchRequest,SearchResponse>
extends BaseRequestBuilder<SearchRequest,SearchResponse>

A search action request builder.

Field Summary

Fields inherited from class org.elasticsearch.action.support.BaseRequestBuilder
`client, request`

Constructor Summary
`SearchRequestBuilder(Client client)`

Method Summary
`SearchRequestBuilder`	`addFacet(AbstractFacetBuilder facet)` Adds a facet to the search operation.
`SearchRequestBuilder`	`addField(String field)` Adds a field to load and return (note, it must be stored) as part of the search request.
`SearchRequestBuilder`	`addFields(String... fields)` Adds the fields to load and return as part of the search request.
`SearchRequestBuilder`	`addHighlightedField(HighlightBuilder.Field field)` Adds a highlighted field.
`SearchRequestBuilder`	`addHighlightedField(String name)` Adds a field to be highlighted with default fragment size of 100 characters, and default number of fragments of 5.
`SearchRequestBuilder`	`addHighlightedField(String name, int fragmentSize)` Adds a field to be highlighted with a provided fragment size (in characters), and default number of fragments of 5.
`SearchRequestBuilder`	`addHighlightedField(String name, int fragmentSize, int numberOfFragments)` Adds a field to be highlighted with a provided fragment size (in characters), and a provided (maximum) number of fragments.
`SearchRequestBuilder`	`addHighlightedField(String name, int fragmentSize, int numberOfFragments, int fragmentOffset)` Adds a field to be highlighted with a provided fragment size (in characters), a provided (maximum) number of fragments and an offset for the highlight.
`SearchRequestBuilder`	`addIndexBoost(String index, float indexBoost)` Sets the boost a specific index will receive when the query is executeed against it.
`SearchRequestBuilder`	`addPartialField(String name, String[] includes, String[] excludes)` Adds a partial field based on _source, with an "includes" and/or "excludes set which can include simple wildcard elements.
`SearchRequestBuilder`	`addPartialField(String name, String include, String exclude)` Adds a partial field based on _source, with an "include" and/or "exclude" set which can include simple wildcard elements.
`SearchRequestBuilder`	`addScriptField(String name, String script)` Adds a script based field to load and return.
`SearchRequestBuilder`	`addScriptField(String name, String script, Map<String,Object> params)` Adds a script based field to load and return.
`SearchRequestBuilder`	`addScriptField(String name, String lang, String script, Map<String,Object> params)` Adds a script based field to load and return.
`SearchRequestBuilder`	`addSort(SortBuilder sort)` Adds a generic sort builder.
`SearchRequestBuilder`	`addSort(String field, SortOrder order)` Adds a sort against the given field name and the sort ordering.
`protected void`	`doExecute(ActionListener<SearchResponse> listener)`
`SearchSourceBuilder`	`internalBuilder()` Returns the internal search source builder used to construct the request.
`SearchRequestBuilder`	`internalBuilder(SearchSourceBuilder sourceBuilder)` Sets the source builder to be used with this request.
`SearchRequest`	`request()`
`SearchRequestBuilder`	`setExplain(boolean explain)` Should each `SearchHit` be returned with an explanation of the hit (ranking).
`SearchRequestBuilder`	`setExtraSource(byte[] source)` Sets the source of the request as a json string.
`SearchRequestBuilder`	`setExtraSource(byte[] source, int offset, int length)` Sets the source of the request as a json string.
`SearchRequestBuilder`	`setExtraSource(BytesReference source)` Sets the source of the request as a json string.
`SearchRequestBuilder`	`setExtraSource(BytesReference source, boolean unsafe)` Sets the source of the request as a json string.
`SearchRequestBuilder`	`setExtraSource(Map source)`
`SearchRequestBuilder`	`setExtraSource(String source)` Sets the source of the request as a json string.
`SearchRequestBuilder`	`setExtraSource(XContentBuilder builder)` Sets the source of the request as a json string.
`SearchRequestBuilder`	`setFacets(byte[] facets)` Sets a raw (xcontent) binary representation of facets to use.
`SearchRequestBuilder`	`setFacets(byte[] facets, int facetsOffset, int facetsLength)` Sets a raw (xcontent) binary representation of facets to use.
`SearchRequestBuilder`	`setFacets(BytesReference facets)` Sets a raw (xcontent) binary representation of facets to use.
`SearchRequestBuilder`	`setFacets(Map facets)` Sets a raw (xcontent) binary representation of facets to use.
`SearchRequestBuilder`	`setFacets(XContentBuilder facets)` Sets a raw (xcontent) binary representation of facets to use.
`SearchRequestBuilder`	`setFilter(byte[] filter)` Sets a filter on the query executed that only applies to the search query (and not facets for example).
`SearchRequestBuilder`	`setFilter(byte[] filter, int filterOffset, int filterLength)` Sets a filter on the query executed that only applies to the search query (and not facets for example).
`SearchRequestBuilder`	`setFilter(BytesReference filter)` Sets a filter on the query executed that only applies to the search query (and not facets for example).
`SearchRequestBuilder`	`setFilter(FilterBuilder filter)` Sets a filter on the query executed that only applies to the search query (and not facets for example).
`SearchRequestBuilder`	`setFilter(Map filter)` Sets a filter on the query executed that only applies to the search query (and not facets for example).
`SearchRequestBuilder`	`setFilter(String filter)` Sets a filter on the query executed that only applies to the search query (and not facets for example).
`SearchRequestBuilder`	`setFilter(XContentBuilder filter)` Sets a filter on the query executed that only applies to the search query (and not facets for example).
`SearchRequestBuilder`	`setFrom(int from)` From index to start the search from.
`SearchRequestBuilder`	`setHighlighterEncoder(String encoder)` The encoder to set for highlighting
`SearchRequestBuilder`	`setHighlighterOrder(String order)` The order of fragments per field.
`SearchRequestBuilder`	`setHighlighterPostTags(String... postTags)` Explicitly set the post tags that will be used for highlighting.
`SearchRequestBuilder`	`setHighlighterPreTags(String... preTags)` Explicitly set the pre tags that will be used for highlighting.
`SearchRequestBuilder`	`setHighlighterRequireFieldMatch(boolean requireFieldMatch)`
`SearchRequestBuilder`	`setHighlighterTagsSchema(String schemaName)` Set a tag scheme that encapsulates a built in pre and post tags.
`SearchRequestBuilder`	`setIgnoreIndices(IgnoreIndices ignoreIndices)` Specifies what type of requested indices to ignore.
`SearchRequestBuilder`	`setIndices(String... indices)` Sets the indices the search will be executed on.
`SearchRequestBuilder`	`setListenerThreaded(boolean listenerThreaded)` Should the listener be called on a separate thread if needed.
`SearchRequestBuilder`	`setMinScore(float minScore)` Sets the minimum score below which docs will be filtered out.
`SearchRequestBuilder`	`setNoFields()` Sets no fields to be loaded, resulting in only id and type to be returned per field.
`SearchRequestBuilder`	`setOperationThreading(SearchOperationThreading operationThreading)` Controls the the search operation threading model.
`SearchRequestBuilder`	`setOperationThreading(String operationThreading)` Sets the string representation of the operation threading model.
`SearchRequestBuilder`	`setPreference(String preference)` Sets the preference to execute the search.
`SearchRequestBuilder`	`setQuery(byte[] queryBinary)` Constructs a new search source builder with a raw search query.
`SearchRequestBuilder`	`setQuery(byte[] queryBinary, int queryBinaryOffset, int queryBinaryLength)` Constructs a new search source builder with a raw search query.
`SearchRequestBuilder`	`setQuery(BytesReference queryBinary)` Constructs a new search source builder with a raw search query.
`SearchRequestBuilder`	`setQuery(Map query)` Constructs a new search source builder with a raw search query.
`SearchRequestBuilder`	`setQuery(QueryBuilder queryBuilder)` Constructs a new search source builder with a search query.
`SearchRequestBuilder`	`setQuery(String query)` Constructs a new search source builder with a raw search query.
`SearchRequestBuilder`	`setQuery(XContentBuilder query)` Constructs a new search source builder with a raw search query.
`SearchRequestBuilder`	`setQueryHint(String queryHint)` A query hint to optionally later be used when routing the request.
`SearchRequestBuilder`	`setRouting(String... routing)` The routing values to control the shards that the search will be executed on.
`SearchRequestBuilder`	`setRouting(String routing)` A comma separated list of routing values to control the shards the search will be executed on.
`SearchRequestBuilder`	`setScroll(Scroll scroll)` If set, will enable scrolling of the search request.
`SearchRequestBuilder`	`setScroll(String keepAlive)` If set, will enable scrolling of the search request for the specified timeout.
`SearchRequestBuilder`	`setScroll(TimeValue keepAlive)` If set, will enable scrolling of the search request for the specified timeout.
`SearchRequestBuilder`	`setSearchType(SearchType searchType)` The search type to execute, defaults to `SearchType.DEFAULT`.
`SearchRequestBuilder`	`setSearchType(String searchType)` The a string representation search type to execute, defaults to `SearchType.DEFAULT`.
`SearchRequestBuilder`	`setSize(int size)` The number of search hits to return.
`SearchRequestBuilder`	`setSource(byte[] source)` Sets the source of the request as a json string.
`SearchRequestBuilder`	`setSource(byte[] source, int offset, int length)` Sets the source of the request as a json string.
`SearchRequestBuilder`	`setSource(BytesReference source)` Sets the source of the request as a json string.
`SearchRequestBuilder`	`setSource(BytesReference source, boolean unsafe)` Sets the source of the request as a json string.
`SearchRequestBuilder`	`setSource(Map source)` Sets the source of the request as a map.
`SearchRequestBuilder`	`setSource(String source)` Sets the source of the request as a json string.
`SearchRequestBuilder`	`setSource(XContentBuilder builder)` Sets the source of the request as a json string.
`SearchRequestBuilder`	`setStats(String... statsGroups)` The stats groups this request will be aggregated under.
`SearchRequestBuilder`	`setTimeout(String timeout)` An optional timeout to control how long search is allowed to take.
`SearchRequestBuilder`	`setTimeout(TimeValue timeout)` An optional timeout to control how long search is allowed to take.
`SearchRequestBuilder`	`setTrackScores(boolean trackScores)` Applies when sorting, and controls if scores will be tracked as well.
`SearchRequestBuilder`	`setTypes(String... types)` The document types to execute the search against.
`SearchRequestBuilder`	`setVersion(boolean version)` Should each `SearchHit` be returned with its version.
`String`	`toString()`

Methods inherited from class org.elasticsearch.action.support.BaseRequestBuilder
`execute, execute`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

Constructor Detail

SearchRequestBuilder

public SearchRequestBuilder(Client client)

Method Detail

setIndices

public SearchRequestBuilder setIndices(String... indices)

Sets the indices the search will be executed on.

setTypes

public SearchRequestBuilder setTypes(String... types)

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

setSearchType

public SearchRequestBuilder setSearchType(SearchType searchType)

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

setSearchType

public SearchRequestBuilder setSearchType(String searchType)
                                   throws ElasticSearchIllegalArgumentException

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".

Throws:: ElasticSearchIllegalArgumentException

setScroll

public SearchRequestBuilder setScroll(Scroll scroll)

If set, will enable scrolling of the search request.

setScroll

public SearchRequestBuilder setScroll(TimeValue keepAlive)

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

setScroll

public SearchRequestBuilder setScroll(String keepAlive)

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

setTimeout

public SearchRequestBuilder setTimeout(TimeValue timeout)

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

setTimeout

public SearchRequestBuilder setTimeout(String timeout)

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

setQueryHint

public SearchRequestBuilder setQueryHint(String queryHint)

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

setRouting

public SearchRequestBuilder setRouting(String routing)

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

setRouting

public SearchRequestBuilder setRouting(String... routing)

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

setPreference

public SearchRequestBuilder setPreference(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.

setOperationThreading

public SearchRequestBuilder setOperationThreading(SearchOperationThreading operationThreading)

Controls the the search operation threading model.

setOperationThreading

public SearchRequestBuilder setOperationThreading(String operationThreading)

Sets the string representation of the operation threading model. Can be one of "no_threads", "single_thread" and "thread_per_shard".

setListenerThreaded

public SearchRequestBuilder setListenerThreaded(boolean listenerThreaded)

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

setIgnoreIndices

public SearchRequestBuilder setIgnoreIndices(IgnoreIndices ignoreIndices)

Specifies what type of requested indices to ignore. For example indices that don't exist.

setQuery

public SearchRequestBuilder setQuery(QueryBuilder queryBuilder)

Constructs a new search source builder with a search query.

See Also:: QueryBuilders

setQuery

public SearchRequestBuilder setQuery(String query)

Constructs a new search source builder with a raw search query.

setQuery

public SearchRequestBuilder setQuery(BytesReference queryBinary)

Constructs a new search source builder with a raw search query.

setQuery

public SearchRequestBuilder setQuery(byte[] queryBinary)

Constructs a new search source builder with a raw search query.

setQuery

public SearchRequestBuilder setQuery(byte[] queryBinary,
                                     int queryBinaryOffset,
                                     int queryBinaryLength)

Constructs a new search source builder with a raw search query.

setQuery

public SearchRequestBuilder setQuery(XContentBuilder query)

Constructs a new search source builder with a raw search query.

setQuery

public SearchRequestBuilder setQuery(Map query)

Constructs a new search source builder with a raw search query.