Interface SearchRequest


@ProviderType public interface SearchRequest
Holds the parameters used when performing a search. Build the search request with the SearchRequestBuilder.
  • Method Details

    • getAggregationsMap

      Map<String,Aggregation> getAggregationsMap()
    • getCollapse

      Collapse getCollapse()
    • getComplexQueryParts

      List<ComplexQueryPart> getComplexQueryParts()
    • getConnectionId

      String getConnectionId()
    • getEntryClassNames

      List<String> getEntryClassNames()
    • getExcludeContributors

      List<String> 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

      List<String> getIncludeContributors()
    • getIndexes

      List<String> getIndexes()
    • getModelIndexerClasses

      @Deprecated List<Class<?>> getModelIndexerClasses()
      Deprecated.
      As of Athanasius (7.3.x), replaced by getModelIndexerClassNames()
    • getModelIndexerClassNames

      List<String> getModelIndexerClassNames()
    • getPaginationStartParameterName

      String getPaginationStartParameterName()
    • getPipelineAggregationsMap

      Map<String,PipelineAggregation> getPipelineAggregationsMap()
    • getPostFilterComplexQueryParts

      List<ComplexQueryPart> getPostFilterComplexQueryParts()
    • getPostFilterQuery

      Query getPostFilterQuery()
    • getQuery

      Query getQuery()
    • getQueryString

      String getQueryString()
    • getRescoreQuery

      @Deprecated Query getRescoreQuery()
      Deprecated.
      As of Athanasius (7.3.x), replaced by getRescores()
    • getRescores

      List<Rescore> getRescores()
      Provides secondary queries to reorder the top documents returned.
      Returns:
      the rescore queries
    • getSize

      Integer getSize()
    • getSorts

      List<Sort> 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()
      Returns true if the explanation for how each hit's score is computed.
      Returns:
      true if the scores are explained; false otherwise
    • isIncludeResponseString

      boolean isIncludeResponseString()
      Returns true if the search engine's response string is included with the returned results.
      Returns:
      true if the response string is included; false otherwise
    • isRetainFacetSelections

      boolean isRetainFacetSelections()