Interface SearchRequest
@ProviderType
public interface SearchRequest
Holds the parameters used when performing a search. Build the search request
with the
SearchRequestBuilder.-
Method Summary
Modifier and TypeMethodDescriptionString[]String[]getFrom()Provides the top hits aggregations used for grouping results by the specified fields.Deprecated.getQuery()Deprecated.As of Athanasius (7.3.x), replaced bygetRescores()Provides secondary queries to reorder the top documents returned.getSize()getSorts()Provides the metric aggregations to be computed for each field.String[]booleanbooleanbooleanReturnstrueif the explanation for how each hit's score is computed.booleanReturnstrueif the search engine's response string is included with the returned results.boolean
-
Method Details
-
getAggregationsMap
Map<String,Aggregation> getAggregationsMap() -
getCollapse
Collapse getCollapse() -
getComplexQueryParts
List<ComplexQueryPart> getComplexQueryParts() -
getConnectionId
String getConnectionId() -
getEntryClassNames
-
getExcludeContributors
-
getFederatedSearchKey
String getFederatedSearchKey() -
getFederatedSearchRequests
List<SearchRequest> getFederatedSearchRequests() -
getFetchSource
Boolean getFetchSource() -
getFetchSourceExcludes
String[] getFetchSourceExcludes() -
getFetchSourceIncludes
String[] getFetchSourceIncludes() -
getFrom
Integer getFrom() -
getGroupByRequests
List<GroupByRequest> getGroupByRequests()Provides the top hits aggregations used for grouping results by the specified fields.- Returns:
- the GroupByRequests that are enabled for the search.
-
getHighlight
Highlight getHighlight() -
getIncludeContributors
-
getIndexes
-
getModelIndexerClasses
Deprecated.As of Athanasius (7.3.x), replaced bygetModelIndexerClassNames() -
getModelIndexerClassNames
-
getPaginationStartParameterName
String getPaginationStartParameterName() -
getPipelineAggregationsMap
Map<String,PipelineAggregation> getPipelineAggregationsMap() -
getPostFilterComplexQueryParts
List<ComplexQueryPart> getPostFilterComplexQueryParts() -
getPostFilterQuery
Query getPostFilterQuery() -
getQuery
Query getQuery() -
getQueryString
String getQueryString() -
getRescoreQuery
Deprecated.As of Athanasius (7.3.x), replaced bygetRescores() -
getRescores
Provides secondary queries to reorder the top documents returned.- Returns:
- the rescore queries
-
getSize
Integer getSize() -
getSorts
-
getStatsRequests
List<StatsRequest> getStatsRequests()Provides the metric aggregations to be computed for each field.- Returns:
- the stats that are enabled for each field
-
getStoredFields
String[] getStoredFields() -
isBasicFacetSelection
boolean isBasicFacetSelection() -
isEmptySearchEnabled
boolean isEmptySearchEnabled() -
isExplain
boolean isExplain()Returnstrueif the explanation for how each hit's score is computed.- Returns:
trueif the scores are explained;falseotherwise
-
isIncludeResponseString
boolean isIncludeResponseString()Returnstrueif the search engine's response string is included with the returned results.- Returns:
trueif the response string is included;falseotherwise
-
isRetainFacetSelections
boolean isRetainFacetSelections()
-
getModelIndexerClassNames()