@ProviderType
public interface SearchRequestBuilder
Modifier and Type | Method and Description |
---|---|
SearchRequestBuilder |
addAggregation(Aggregation aggregation) |
SearchRequestBuilder |
addComplexQueryPart(ComplexQueryPart complexQueryPart) |
SearchRequestBuilder |
addFederatedSearchRequest(SearchRequest searchRequest) |
SearchRequestBuilder |
addIndex(java.lang.String index) |
SearchRequestBuilder |
addPipelineAggregation(PipelineAggregation pipelineAggregation) |
SearchRequestBuilder |
addPostFilterQueryPart(ComplexQueryPart complexQueryPart) |
SearchRequestBuilder |
addRescore(Rescore rescore) |
SearchRequestBuilder |
addSelectedFieldNames(java.lang.String... selectedFieldNames)
Adds fields to include in the search results as a map of keys and values.
|
SearchRequestBuilder |
addSort(Sort sort) |
SearchRequestBuilder |
basicFacetSelection(boolean basicFacetSelection) |
SearchRequest |
build()
Builds the search request.
|
SearchRequestBuilder |
companyId(java.lang.Long companyId) |
SearchRequestBuilder |
connectionId(java.lang.String connectionId) |
SearchRequestBuilder |
emptySearchEnabled(boolean emptySearchEnabled) |
SearchRequestBuilder |
entryClassNames(java.lang.String... entryClassNames) |
SearchRequestBuilder |
excludeContributors(java.lang.String... ids) |
SearchRequestBuilder |
explain(boolean explain)
Enables explanation of how each hit's score was computed.
|
SearchRequestBuilder |
federatedSearchKey(java.lang.String federatedSearchKey) |
SearchRequestBuilder |
fetchSource(boolean fetchSource) |
SearchRequestBuilder |
fetchSourceExcludes(java.lang.String[] fetchSourceExcludes) |
SearchRequestBuilder |
fetchSourceIncludes(java.lang.String[] fetchSourceIncludes) |
SearchRequestBuilder |
fields(java.lang.String... fields) |
SearchRequestBuilder |
from(java.lang.Integer from) |
SearchRequestBuilder |
getFederatedSearchRequestBuilder(java.lang.String federatedSearchKey) |
SearchRequestBuilder |
groupByRequests(GroupByRequest... groupByRequests)
Provides a top hits aggregations for each of the specified fields.
|
SearchRequestBuilder |
groupIds(long... groupIds) |
SearchRequestBuilder |
highlight(Highlight highlight) |
SearchRequestBuilder |
highlightEnabled(boolean highlightEnabled) |
SearchRequestBuilder |
highlightFields(java.lang.String... highlightFields) |
SearchRequestBuilder |
includeContributors(java.lang.String... ids) |
SearchRequestBuilder |
includeResponseString(boolean includeResponseString)
Enables inclusion of the search engine's response string with the
returned results.
|
SearchRequestBuilder |
indexes(java.lang.String... indexes) |
SearchRequestBuilder |
locale(java.util.Locale locale) |
SearchRequestBuilder |
modelIndexerClasses(java.lang.Class<?>... classes) |
SearchRequestBuilder |
modelIndexerClassNames(java.lang.String... classNames) |
SearchRequestBuilder |
ownerUserId(java.lang.Long userId) |
void |
paginationStartParameterName(java.lang.String paginationStartParameterName) |
SearchRequestBuilder |
postFilterQuery(Query query) |
SearchRequestBuilder |
query(Query query) |
SearchRequestBuilder |
queryString(java.lang.String queryString) |
SearchRequestBuilder |
rescoreQuery(Query rescoreQuery)
Deprecated.
As of Athanasius (7.3.x), replaced by
rescores(List) |
SearchRequestBuilder |
rescores(java.util.List<Rescore> rescores)
Provides secondary queries to reorder the top documents returned.
|
SearchRequestBuilder |
size(java.lang.Integer size) |
SearchRequestBuilder |
sorts(Sort... sorts) |
SearchRequestBuilder |
statsRequests(StatsRequest... statsRequests)
Provides the metric aggregations to be computed for each field.
|
SearchRequestBuilder |
withFacetContext(java.util.function.Consumer<FacetContext> facetContextConsumer) |
<T> T |
withFacetContextGet(java.util.function.Function<FacetContext,T> facetContextFunction) |
SearchRequestBuilder |
withSearchContext(java.util.function.Consumer<com.liferay.portal.kernel.search.SearchContext> searchContextConsumer) |
<T> T |
withSearchContextGet(java.util.function.Function<com.liferay.portal.kernel.search.SearchContext,T> searchContextFunction) |
SearchRequestBuilder |
withSearchRequestBuilder(java.util.function.Consumer<SearchRequestBuilder>... searchRequestBuilderConsumers) |
SearchRequestBuilder addAggregation(Aggregation aggregation)
SearchRequestBuilder addComplexQueryPart(ComplexQueryPart complexQueryPart)
SearchRequestBuilder addFederatedSearchRequest(SearchRequest searchRequest)
SearchRequestBuilder addIndex(java.lang.String index)
SearchRequestBuilder addPipelineAggregation(PipelineAggregation pipelineAggregation)
SearchRequestBuilder addPostFilterQueryPart(ComplexQueryPart complexQueryPart)
SearchRequestBuilder addRescore(Rescore rescore)
SearchRequestBuilder addSelectedFieldNames(java.lang.String... selectedFieldNames)
selectedFieldNames
- the names of the fields to returnSearchRequestBuilder addSort(Sort sort)
SearchRequestBuilder basicFacetSelection(boolean basicFacetSelection)
SearchRequest build()
SearchRequestBuilder companyId(java.lang.Long companyId)
SearchRequestBuilder connectionId(java.lang.String connectionId)
SearchRequestBuilder emptySearchEnabled(boolean emptySearchEnabled)
SearchRequestBuilder entryClassNames(java.lang.String... entryClassNames)
SearchRequestBuilder excludeContributors(java.lang.String... ids)
SearchRequestBuilder explain(boolean explain)
explain
- whether to explain scoresSearchRequestBuilder federatedSearchKey(java.lang.String federatedSearchKey)
SearchRequestBuilder fetchSource(boolean fetchSource)
SearchRequestBuilder fetchSourceExcludes(java.lang.String[] fetchSourceExcludes)
SearchRequestBuilder fetchSourceIncludes(java.lang.String[] fetchSourceIncludes)
SearchRequestBuilder fields(java.lang.String... fields)
SearchRequestBuilder from(java.lang.Integer from)
SearchRequestBuilder getFederatedSearchRequestBuilder(java.lang.String federatedSearchKey)
SearchRequestBuilder groupByRequests(GroupByRequest... groupByRequests)
groupByRequests
- the grouping that is enabled for each fieldSearchRequestBuilder groupIds(long... groupIds)
SearchRequestBuilder highlight(Highlight highlight)
SearchRequestBuilder highlightEnabled(boolean highlightEnabled)
SearchRequestBuilder highlightFields(java.lang.String... highlightFields)
SearchRequestBuilder includeContributors(java.lang.String... ids)
SearchRequestBuilder includeResponseString(boolean includeResponseString)
includeResponseString
- whether to include the response stringSearchRequestBuilder indexes(java.lang.String... indexes)
SearchRequestBuilder locale(java.util.Locale locale)
SearchRequestBuilder modelIndexerClasses(java.lang.Class<?>... classes)
SearchRequestBuilder modelIndexerClassNames(java.lang.String... classNames)
SearchRequestBuilder ownerUserId(java.lang.Long userId)
void paginationStartParameterName(java.lang.String paginationStartParameterName)
SearchRequestBuilder postFilterQuery(Query query)
SearchRequestBuilder query(Query query)
SearchRequestBuilder queryString(java.lang.String queryString)
@Deprecated SearchRequestBuilder rescoreQuery(Query rescoreQuery)
rescores(List)
SearchRequestBuilder rescores(java.util.List<Rescore> rescores)
rescores
- the rescore queriesSearchRequestBuilder size(java.lang.Integer size)
SearchRequestBuilder sorts(Sort... sorts)
SearchRequestBuilder statsRequests(StatsRequest... statsRequests)
statsRequests
- the stats that are enabled for each fieldSearchRequestBuilder withFacetContext(java.util.function.Consumer<FacetContext> facetContextConsumer)
<T> T withFacetContextGet(java.util.function.Function<FacetContext,T> facetContextFunction)
SearchRequestBuilder withSearchContext(java.util.function.Consumer<com.liferay.portal.kernel.search.SearchContext> searchContextConsumer)
<T> T withSearchContextGet(java.util.function.Function<com.liferay.portal.kernel.search.SearchContext,T> searchContextFunction)
SearchRequestBuilder withSearchRequestBuilder(java.util.function.Consumer<SearchRequestBuilder>... searchRequestBuilderConsumers)