Package com.algolia.model.search

Class BrowseResponse<T>

java.lang.Object
com.algolia.model.search.BrowseResponse<T>
public class BrowseResponse<T> extends Object
BrowseResponse

  • Constructor Details

    • BrowseResponse

      public BrowseResponse()

  • Method Details

    • setAbTestID

      public BrowseResponse<T> 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 BrowseResponse<T> 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 BrowseResponse<T> setAroundLatLng(String aroundLatLng)

    • getAroundLatLng

      @Nullable public String getAroundLatLng()
      Computed geographical location.

    • setAutomaticRadius

      public BrowseResponse<T> setAutomaticRadius(String automaticRadius)

    • getAutomaticRadius

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

    • setExhaustive

      public BrowseResponse<T> setExhaustive(Exhaustive exhaustive)

    • getExhaustive

      @Nullable public Exhaustive getExhaustive()
      Get exhaustive

    • setExhaustiveFacetsCount

      public BrowseResponse<T> setExhaustiveFacetsCount(Boolean exhaustiveFacetsCount)

    • getExhaustiveFacetsCount

      @Deprecated @Nullable public Boolean getExhaustiveFacetsCount()
      Deprecated.
      See the `facetsCount` field of the `exhaustive` object in the response.

    • setExhaustiveNbHits

      public BrowseResponse<T> setExhaustiveNbHits(Boolean exhaustiveNbHits)

    • getExhaustiveNbHits

      @Deprecated @Nullable public Boolean getExhaustiveNbHits()
      Deprecated.
      See the `nbHits` field of the `exhaustive` object in the response.

    • setExhaustiveTypo

      public BrowseResponse<T> setExhaustiveTypo(Boolean exhaustiveTypo)

    • getExhaustiveTypo

      @Deprecated @Nullable public Boolean getExhaustiveTypo()
      Deprecated.
      See the `typo` field of the `exhaustive` object in the response.

    • setFacets

      public BrowseResponse<T> setFacets(Map<String,Map<String,Integer>> facets)

    • putFacets

      public BrowseResponse<T> 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 BrowseResponse<T> setFacetsStats(Map<String,FacetsStats> facetsStats)

    • putFacetsStats

      public BrowseResponse<T> putFacetsStats(String key, FacetsStats facetsStatsItem)

    • getFacetsStats

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

    • setHitsPerPage

      public BrowseResponse<T> setHitsPerPage(Integer hitsPerPage)

    • getHitsPerPage

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

    • setIndex

      public BrowseResponse<T> setIndex(String index)

    • getIndex

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

    • setIndexUsed

      public BrowseResponse<T> 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 BrowseResponse<T> setMessage(String message)

    • getMessage

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

    • setNbHits

      public BrowseResponse<T> setNbHits(Integer nbHits)

    • getNbHits

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

    • setNbPages

      public BrowseResponse<T> setNbPages(Integer nbPages)

    • getNbPages

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

    • setNbSortedHits

      public BrowseResponse<T> setNbSortedHits(Integer nbSortedHits)

    • getNbSortedHits

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

    • setPage

      public BrowseResponse<T> setPage(Integer page)

    • getPage

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

    • setParsedQuery

      public BrowseResponse<T> 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 BrowseResponse<T> setProcessingTimeMS(Integer processingTimeMS)

    • getProcessingTimeMS

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

    • setProcessingTimingsMS

      public BrowseResponse<T> setProcessingTimingsMS(Object processingTimingsMS)

    • getProcessingTimingsMS

      @Nullable public Object getProcessingTimingsMS()
      Experimental. List of processing steps and their times, in milliseconds. You can use this list to investigate performance issues.

    • setQueryAfterRemoval

      public BrowseResponse<T> 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.

    • setRedirect

      public BrowseResponse<T> setRedirect(Redirect redirect)

    • getRedirect

      @Nullable public Redirect getRedirect()
      Get redirect

    • setRenderingContent

      public BrowseResponse<T> setRenderingContent(RenderingContent renderingContent)

    • getRenderingContent

      @Nullable public RenderingContent getRenderingContent()
      Get renderingContent

    • setServerTimeMS

      public BrowseResponse<T> setServerTimeMS(Integer serverTimeMS)

    • getServerTimeMS

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

    • setServerUsed

      public BrowseResponse<T> setServerUsed(String serverUsed)

    • getServerUsed

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

    • setUserData

      public BrowseResponse<T> setUserData(Object userData)

    • getUserData

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

    • setHits

      public BrowseResponse<T> setHits(List<T> hits)

    • addHits

      public BrowseResponse<T> addHits(T hitsItem)

    • getHits

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

    • setQuery

      public BrowseResponse<T> setQuery(String query)

    • getQuery

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

    • setParams

      public BrowseResponse<T> setParams(String params)

    • getParams

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

    • setCursor

      public BrowseResponse<T> setCursor(String cursor)

    • getCursor

      @Nullable public String getCursor()
      Cursor indicating the location to resume browsing from. Must match the value returned by the previous call. Pass this value to the subsequent browse call to get the next page of results. When the end of the index has been reached, `cursor` is absent from the response.

    • 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