Writeable
, ToXContent
, ToXContentObject
, Rewriteable<SearchSourceBuilder>
public final class SearchSourceBuilder extends java.lang.Object implements Writeable, ToXContentObject, Rewriteable<SearchSourceBuilder>
searchSource()
.Modifier and Type | Class | Description |
---|---|---|
static class |
SearchSourceBuilder.IndexBoost |
|
static class |
SearchSourceBuilder.ScriptField |
ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params
Writeable.Reader<V>, Writeable.Writer<V>
MAX_REWRITE_ROUNDS
EMPTY_PARAMS
Constructor | Description |
---|---|
SearchSourceBuilder() |
Constructs a new search source builder.
|
SearchSourceBuilder(StreamInput in) |
Read from a stream.
|
Modifier and Type | Method | Description |
---|---|---|
SearchSourceBuilder |
addRescorer(RescorerBuilder<?> rescoreBuilder) |
|
SearchSourceBuilder |
aggregation(AggregationBuilder aggregation) |
Add an aggregation to perform as part of the search.
|
SearchSourceBuilder |
aggregation(PipelineAggregationBuilder aggregation) |
Add an aggregation to perform as part of the search.
|
AggregatorFactories.Builder |
aggregations() |
Gets the bytes representing the aggregation builders for this request.
|
SearchSourceBuilder |
clearRescorers() |
|
CollapseBuilder |
collapse() |
|
SearchSourceBuilder |
collapse(CollapseBuilder collapse) |
|
SearchSourceBuilder |
copyWithNewSlice(SliceBuilder slice) |
Create a shallow copy of this builder with a new slice configuration.
|
SearchSourceBuilder |
docValueField(java.lang.String name) |
Adds a field to load from the docvalue and return as part of the
search request.
|
java.util.List<java.lang.String> |
docValueFields() |
Gets the docvalue fields.
|
boolean |
equals(java.lang.Object obj) |
|
java.lang.Boolean |
explain() |
Indicates whether each search hit will be returned with an explanation of
the hit (ranking)
|
SearchSourceBuilder |
explain(java.lang.Boolean explain) |
Should each
SearchHit be returned with
an explanation of the hit (ranking). |
java.util.List<SearchExtBuilder> |
ext() |
|
SearchSourceBuilder |
ext(java.util.List<SearchExtBuilder> searchExtBuilders) |
|
FetchSourceContext |
fetchSource() |
Gets the
FetchSourceContext which defines how the _source should
be fetched. |
SearchSourceBuilder |
fetchSource(boolean fetch) |
Indicates whether the response should contain the stored _source for
every hit
|
SearchSourceBuilder |
fetchSource(java.lang.String[] includes,
java.lang.String[] excludes) |
Indicate that _source should be returned with every hit, with an
"include" and/or "exclude" set which can include simple wildcard
elements.
|
SearchSourceBuilder |
fetchSource(java.lang.String include,
java.lang.String exclude) |
Indicate that _source should be returned with every hit, with an
"include" and/or "exclude" set which can include simple wildcard
elements.
|
SearchSourceBuilder |
fetchSource(FetchSourceContext fetchSourceContext) |
Indicate how the _source should be fetched.
|
int |
from() |
Gets the from index to start the search from.
|
SearchSourceBuilder |
from(int from) |
From index to start the search from.
|
static SearchSourceBuilder |
fromXContent(XContentParser parser) |
|
int |
hashCode() |
|
static HighlightBuilder |
highlight() |
A static factory method to construct new search highlights.
|
HighlightBuilder |
highlighter() |
Gets the highlighter builder for this request.
|
SearchSourceBuilder |
highlighter(HighlightBuilder highlightBuilder) |
Adds highlight to perform as part of the search.
|
SearchSourceBuilder |
indexBoost(java.lang.String index,
float indexBoost) |
Sets the boost a specific index or alias will receive when the query is executed
against it.
|
java.util.List<SearchSourceBuilder.IndexBoost> |
indexBoosts() |
Gets the boost a specific indices or aliases will receive when the query is
executed against them.
|
boolean |
isSuggestOnly() |
|
java.lang.Float |
minScore() |
Gets the minimum score below which docs will be filtered out.
|
SearchSourceBuilder |
minScore(float minScore) |
Sets the minimum score below which docs will be filtered out.
|
void |
parseXContent(XContentParser parser) |
Parse some xContent into this SearchSourceBuilder, overwriting any values specified in the xContent.
|
QueryBuilder |
postFilter() |
Gets the post filter for this request
|
SearchSourceBuilder |
postFilter(QueryBuilder postFilter) |
Sets a filter that will be executed after the query has been executed and
only has affect on the search hits (not aggregations).
|
boolean |
profile() |
Return whether to profile query execution, or
null if
unspecified. |
SearchSourceBuilder |
profile(boolean profile) |
Should the query be profiled.
|
QueryBuilder |
query() |
Gets the query for this request
|
SearchSourceBuilder |
query(QueryBuilder query) |
Sets the search query for this request.
|
java.util.List<RescorerBuilder> |
rescores() |
Gets the bytes representing the rescore builders for this request.
|
SearchSourceBuilder |
rewrite(QueryRewriteContext context) |
Rewrites this search source builder into its primitive form.
|
SearchSourceBuilder |
scriptField(java.lang.String name,
Script script) |
Adds a script field under the given name with the provided script.
|
SearchSourceBuilder |
scriptField(java.lang.String name,
Script script,
boolean ignoreFailure) |
Adds a script field under the given name with the provided script.
|
java.util.List<SearchSourceBuilder.ScriptField> |
scriptFields() |
Gets the script fields.
|
java.lang.Object[] |
searchAfter() |
The sort values that indicates which docs this request should "search after".
|
SearchSourceBuilder |
searchAfter(java.lang.Object[] values) |
Set the sort values that indicates which docs this request should "search after".
|
static SearchSourceBuilder |
searchSource() |
A static factory method to construct a new search source.
|
int |
size() |
Gets the number of search hits to return.
|
SearchSourceBuilder |
size(int size) |
The number of search hits to return.
|
SliceBuilder |
slice() |
Gets the slice used to filter the search hits, the top hits and the aggregations.
|
SearchSourceBuilder |
slice(SliceBuilder builder) |
Sets a filter that will restrict the search hits, the top hits and the aggregations to a slice of the results
of the main query.
|
SearchSourceBuilder |
sort(java.lang.String name) |
Add a sort against the given field name.
|
SearchSourceBuilder |
sort(java.lang.String name,
SortOrder order) |
Adds a sort against the given field name and the sort ordering.
|
SearchSourceBuilder |
sort(SortBuilder<?> sort) |
Adds a sort builder.
|
java.util.List<SortBuilder<?>> |
sorts() |
Gets the bytes representing the sort builders for this request.
|
java.util.List<java.lang.String> |
stats() |
The stats groups this request will be aggregated under.
|
SearchSourceBuilder |
stats(java.util.List<java.lang.String> statsGroups) |
The stats groups this request will be aggregated under.
|
SearchSourceBuilder |
storedField(java.lang.String name) |
Adds a stored field to load and return as part of the
search request.
|
StoredFieldsContext |
storedFields() |
Gets the stored fields context.
|
SearchSourceBuilder |
storedFields(java.util.List<java.lang.String> fields) |
Sets the stored fields to load and return as part of the search request.
|
SearchSourceBuilder |
storedFields(StoredFieldsContext context) |
Indicates how the stored fields should be fetched.
|
SuggestBuilder |
suggest() |
Gets the suggester builder for this request.
|
SearchSourceBuilder |
suggest(SuggestBuilder suggestBuilder) |
|
int |
terminateAfter() |
Gets the number of documents to terminate after collecting.
|
SearchSourceBuilder |
terminateAfter(int terminateAfter) |
An optional terminate_after to terminate the search after collecting
terminateAfter documents |
TimeValue |
timeout() |
Gets the timeout to control how long search is allowed to take.
|
SearchSourceBuilder |
timeout(TimeValue timeout) |
An optional timeout to control how long search is allowed to take.
|
java.lang.String |
toString() |
|
java.lang.String |
toString(ToXContent.Params params) |
|
XContentBuilder |
toXContent(XContentBuilder builder,
ToXContent.Params params) |
|
boolean |
trackScores() |
Indicates whether scores will be tracked for this request.
|
SearchSourceBuilder |
trackScores(boolean trackScores) |
Applies when sorting, and controls if scores will be tracked as well.
|
boolean |
trackTotalHits() |
Indicates if the total hit count for the query should be tracked.
|
SearchSourceBuilder |
trackTotalHits(boolean trackTotalHits) |
|
java.lang.Boolean |
version() |
Indicates whether the document's version will be included in the search
hits.
|
SearchSourceBuilder |
version(java.lang.Boolean version) |
Should each
SearchHit be returned with a
version associated with it. |
void |
writeTo(StreamOutput out) |
Write this into the StreamOutput.
|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
rewrite, rewrite, rewrite, rewriteAndFetch, rewriteAndFetch
isFragment
public static final ParseField FROM_FIELD
public static final ParseField SIZE_FIELD
public static final ParseField TIMEOUT_FIELD
public static final ParseField TERMINATE_AFTER_FIELD
public static final ParseField QUERY_FIELD
public static final ParseField POST_FILTER_FIELD
public static final ParseField MIN_SCORE_FIELD
public static final ParseField VERSION_FIELD
public static final ParseField EXPLAIN_FIELD
public static final ParseField _SOURCE_FIELD
public static final ParseField STORED_FIELDS_FIELD
public static final ParseField DOCVALUE_FIELDS_FIELD
public static final ParseField SCRIPT_FIELDS_FIELD
public static final ParseField SCRIPT_FIELD
public static final ParseField IGNORE_FAILURE_FIELD
public static final ParseField SORT_FIELD
public static final ParseField TRACK_SCORES_FIELD
public static final ParseField TRACK_TOTAL_HITS_FIELD
public static final ParseField INDICES_BOOST_FIELD
public static final ParseField AGGREGATIONS_FIELD
public static final ParseField AGGS_FIELD
public static final ParseField HIGHLIGHT_FIELD
public static final ParseField SUGGEST_FIELD
public static final ParseField RESCORE_FIELD
public static final ParseField STATS_FIELD
public static final ParseField EXT_FIELD
public static final ParseField PROFILE_FIELD
public static final ParseField SEARCH_AFTER
public static final ParseField COLLAPSE
public static final ParseField SLICE
public static final ParseField ALL_FIELDS_FIELDS
public SearchSourceBuilder()
public SearchSourceBuilder(StreamInput in) throws java.io.IOException
java.io.IOException
public static SearchSourceBuilder fromXContent(XContentParser parser) throws java.io.IOException
java.io.IOException
public static SearchSourceBuilder searchSource()
public static HighlightBuilder highlight()
public void writeTo(StreamOutput out) throws java.io.IOException
Writeable
public SearchSourceBuilder query(QueryBuilder query)
QueryBuilders
public QueryBuilder query()
public SearchSourceBuilder postFilter(QueryBuilder postFilter)
public QueryBuilder postFilter()
public SearchSourceBuilder from(int from)
public int from()
public SearchSourceBuilder size(int size)
public int size()
public SearchSourceBuilder minScore(float minScore)
public java.lang.Float minScore()
public SearchSourceBuilder explain(java.lang.Boolean explain)
SearchHit
be returned with
an explanation of the hit (ranking).public java.lang.Boolean explain()
public SearchSourceBuilder version(java.lang.Boolean version)
SearchHit
be returned with a
version associated with it.public java.lang.Boolean version()
public SearchSourceBuilder timeout(TimeValue timeout)
public TimeValue timeout()
public SearchSourceBuilder terminateAfter(int terminateAfter)
terminateAfter
documentspublic int terminateAfter()
public SearchSourceBuilder sort(java.lang.String name, SortOrder order)
name
- The name of the fieldorder
- The sort orderingpublic SearchSourceBuilder sort(java.lang.String name)
name
- The name of the field to sort bypublic SearchSourceBuilder sort(SortBuilder<?> sort)
public java.util.List<SortBuilder<?>> sorts()
public SearchSourceBuilder trackScores(boolean trackScores)
public boolean trackScores()
public boolean trackTotalHits()
public SearchSourceBuilder trackTotalHits(boolean trackTotalHits)
public java.lang.Object[] searchAfter()
public SearchSourceBuilder searchAfter(java.lang.Object[] values)
public SearchSourceBuilder slice(SliceBuilder builder)
public SliceBuilder slice()
public CollapseBuilder collapse()
public SearchSourceBuilder collapse(CollapseBuilder collapse)
public SearchSourceBuilder aggregation(AggregationBuilder aggregation)
public SearchSourceBuilder aggregation(PipelineAggregationBuilder aggregation)
public AggregatorFactories.Builder aggregations()
public SearchSourceBuilder highlighter(HighlightBuilder highlightBuilder)
public HighlightBuilder highlighter()
public SearchSourceBuilder suggest(SuggestBuilder suggestBuilder)
public SuggestBuilder suggest()
public SearchSourceBuilder addRescorer(RescorerBuilder<?> rescoreBuilder)
public SearchSourceBuilder clearRescorers()
public SearchSourceBuilder profile(boolean profile)
public boolean profile()
null
if
unspecified.public java.util.List<RescorerBuilder> rescores()
public SearchSourceBuilder fetchSource(boolean fetch)
public SearchSourceBuilder fetchSource(@Nullable java.lang.String include, @Nullable java.lang.String exclude)
include
- An optional include (optionally wildcarded) pattern to filter
the returned _sourceexclude
- An optional exclude (optionally wildcarded) pattern to filter
the returned _sourcepublic SearchSourceBuilder fetchSource(@Nullable java.lang.String[] includes, @Nullable java.lang.String[] excludes)
includes
- An optional list of include (optionally wildcarded) pattern to
filter the returned _sourceexcludes
- An optional list of exclude (optionally wildcarded) pattern to
filter the returned _sourcepublic SearchSourceBuilder fetchSource(@Nullable FetchSourceContext fetchSourceContext)
public FetchSourceContext fetchSource()
FetchSourceContext
which defines how the _source should
be fetched.public SearchSourceBuilder storedField(java.lang.String name)
public SearchSourceBuilder storedFields(java.util.List<java.lang.String> fields)
public SearchSourceBuilder storedFields(StoredFieldsContext context)
public StoredFieldsContext storedFields()
public java.util.List<java.lang.String> docValueFields()
public SearchSourceBuilder docValueField(java.lang.String name)
public SearchSourceBuilder scriptField(java.lang.String name, Script script)
name
- The name of the fieldscript
- The scriptpublic SearchSourceBuilder scriptField(java.lang.String name, Script script, boolean ignoreFailure)
name
- The name of the fieldscript
- The scriptpublic java.util.List<SearchSourceBuilder.ScriptField> scriptFields()
public SearchSourceBuilder indexBoost(java.lang.String index, float indexBoost)
index
- The index or alias to apply the boost againstindexBoost
- The boost to apply to the indexpublic java.util.List<SearchSourceBuilder.IndexBoost> indexBoosts()
public SearchSourceBuilder stats(java.util.List<java.lang.String> statsGroups)
public java.util.List<java.lang.String> stats()
public SearchSourceBuilder ext(java.util.List<SearchExtBuilder> searchExtBuilders)
public java.util.List<SearchExtBuilder> ext()
public boolean isSuggestOnly()
public SearchSourceBuilder rewrite(QueryRewriteContext context) throws java.io.IOException
rewrite
in interface Rewriteable<SearchSourceBuilder>
java.io.IOException
public SearchSourceBuilder copyWithNewSlice(SliceBuilder slice)
public void parseXContent(XContentParser parser) throws java.io.IOException
fromXContent(XContentParser)
if you have normal defaults.java.io.IOException
public XContentBuilder toXContent(XContentBuilder builder, ToXContent.Params params) throws java.io.IOException
toXContent
in interface ToXContent
java.io.IOException
public int hashCode()
hashCode
in class java.lang.Object
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public java.lang.String toString()
toString
in class java.lang.Object
public java.lang.String toString(ToXContent.Params params)