Package com.algolia.model.search

Class SearchResponse<T>

java.lang.Object
com.algolia.model.search.SearchResponse<T>
All Implemented Interfaces:
SearchResult
public class SearchResponse<T> extends Object implements SearchResult
SearchResponse

  • Constructor Details

    • SearchResponse

      public SearchResponse()

  • Method Details

    • setAbTestID

      public SearchResponse setAbTestID(Integer abTestID)

    • getAbTestID

      @Nullable public Integer getAbTestID()
      A/B test ID. This is only included in the response for indices that are part of an A/B test.

    • setAbTestVariantID

      public SearchResponse setAbTestVariantID(Integer abTestVariantID)

    • getAbTestVariantID

      @Nullable public Integer getAbTestVariantID()
      Variant ID. This is only included in the response for indices that are part of an A/B test. minimum: 1

    • setAroundLatLng

      public SearchResponse setAroundLatLng(String aroundLatLng)

    • getAroundLatLng

      @Nullable public String getAroundLatLng()
      Computed geographical location.

    • setAutomaticRadius

      public SearchResponse setAutomaticRadius(String automaticRadius)

    • getAutomaticRadius

      @Nullable public String getAutomaticRadius()
      Automatically-computed radius.

    • setExhaustiveFacetsCount

      public SearchResponse setExhaustiveFacetsCount(Boolean exhaustiveFacetsCount)

    • getExhaustiveFacetsCount

      @Nullable public Boolean getExhaustiveFacetsCount()
      Indicates whether the facet count is exhaustive (exact) or approximate.

    • setExhaustiveNbHits

      public SearchResponse setExhaustiveNbHits(Boolean exhaustiveNbHits)

    • getExhaustiveNbHits

      @Nullable public Boolean getExhaustiveNbHits()
      Indicates whether the number of hits `nbHits` is exhaustive (exact) or approximate.

    • setExhaustiveTypo

      public SearchResponse setExhaustiveTypo(Boolean exhaustiveTypo)

    • getExhaustiveTypo

      @Nullable public Boolean getExhaustiveTypo()
      Indicates whether the search for typos was exhaustive (exact) or approximate.

    • setFacets

      public SearchResponse setFacets(Map<String,Map<String,Integer>> facets)

    • putFacets

      public SearchResponse putFacets(String key, Map<String,Integer> facetsItem)

    • getFacets

      @Nullable public Map<String,Map<String,Integer>> getFacets()
      Mapping of each facet name to the corresponding facet counts.

    • setFacetsStats

      public SearchResponse setFacetsStats(Map<String,FacetsStats> facetsStats)

    • putFacetsStats

      public SearchResponse putFacetsStats(String key, FacetsStats facetsStatsItem)

    • getFacetsStats

      @Nullable public Map<String,FacetsStats> getFacetsStats()
      Statistics for numerical facets.

    • setHitsPerPage

      public SearchResponse setHitsPerPage(Integer hitsPerPage)

    • getHitsPerPage

      @Nonnull public Integer getHitsPerPage()
      Number of hits per page. minimum: 1 maximum: 1000

    • setIndex

      public SearchResponse setIndex(String index)

    • getIndex

      @Nullable public String getIndex()
      Index name used for the query.

    • setIndexUsed

      public SearchResponse setIndexUsed(String indexUsed)

    • getIndexUsed

      @Nullable public String getIndexUsed()
      Index name used for the query. During A/B testing, the targeted index isn't always the index used by the query.

    • setMessage

      public SearchResponse setMessage(String message)

    • getMessage

      @Nullable public String getMessage()
      Warnings about the query.

    • setNbHits

      public SearchResponse setNbHits(Integer nbHits)

    • getNbHits

      @Nonnull public Integer getNbHits()
      Number of hits the search query matched.

    • setNbPages

      public SearchResponse setNbPages(Integer nbPages)

    • getNbPages

      @Nonnull public Integer getNbPages()
      Number of pages of results for the current query.

    • setNbSortedHits

      public SearchResponse setNbSortedHits(Integer nbSortedHits)

    • getNbSortedHits

      @Nullable public Integer getNbSortedHits()
      Number of hits selected and sorted by the relevant sort algorithm.

    • setPage

      public SearchResponse setPage(Integer page)

    • getPage

      @Nonnull public Integer getPage()
      Page to retrieve (the first page is `0`, not `1`).

    • setRedirect

      public SearchResponse setRedirect(BaseSearchResponseRedirect redirect)

    • getRedirect

      @Nullable public BaseSearchResponseRedirect getRedirect()
      Get redirect

    • setParsedQuery

      public SearchResponse setParsedQuery(String parsedQuery)

    • getParsedQuery

      @Nullable public String getParsedQuery()
      Post-[normalization](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/#what-does-normalization-mean) query string that will be searched.

    • setProcessingTimeMS

      public SearchResponse setProcessingTimeMS(Integer processingTimeMS)

    • getProcessingTimeMS

      @Nonnull public Integer getProcessingTimeMS()
      Time the server took to process the request, in milliseconds.

    • setQueryAfterRemoval

      public SearchResponse setQueryAfterRemoval(String queryAfterRemoval)

    • getQueryAfterRemoval

      @Nullable public String getQueryAfterRemoval()
      Markup text indicating which parts of the original query have been removed to retrieve a non-empty result set.

    • setServerUsed

      public SearchResponse setServerUsed(String serverUsed)

    • getServerUsed

      @Nullable public String getServerUsed()
      Host name of the server that processed the request.

    • setUserData

      public SearchResponse setUserData(Object userData)

    • getUserData

      @Nullable public Object getUserData()
      Lets you store custom data in your indices.

    • setRenderingContent

      public SearchResponse setRenderingContent(RenderingContent renderingContent)

    • getRenderingContent

      @Nullable public RenderingContent getRenderingContent()
      Get renderingContent

    • setHits

      public SearchResponse setHits(List<T> hits)

    • addHits

      public SearchResponse addHits(T hitsItem)

    • getHits

      @Nonnull public List<T> getHits()
      Get hits

    • setQuery

      public SearchResponse setQuery(String query)

    • getQuery

      @Nonnull public String getQuery()
      Text to search for in an index.

    • setParams

      public SearchResponse setParams(String params)

    • getParams

      @Nonnull public String getParams()
      URL-encoded string of all search parameters.

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object