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()
      Distance from a central coordinate provided by `aroundLatLng`.

    • setExhaustive

      public BrowseResponse<T> setExhaustive(Exhaustive exhaustive)

    • getExhaustive

      @Nullable public Exhaustive getExhaustive()
      Get exhaustive

    • setAppliedRules

      public BrowseResponse<T> setAppliedRules(List<Object> appliedRules)

    • addAppliedRules

      public BrowseResponse<T> addAppliedRules(Object appliedRulesItem)

    • getAppliedRules

      @Nullable public List<Object> getAppliedRules()
      Rules applied to the query.

    • 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()
      Facet counts.

    • setFacetsStats

      public BrowseResponse<T> setFacetsStats(Map<String,FacetStats> facetsStats)

    • putFacetsStats

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

    • getFacetsStats

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

    • 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.

    • setNbSortedHits

      public BrowseResponse<T> setNbSortedHits(Integer nbSortedHits)

    • getNbSortedHits

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

    • 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()
      An object with custom data. You can store up to 32kB as custom data.

    • setQueryID

      public BrowseResponse<T> setQueryID(String queryID)

    • getQueryID

      @Nullable public String getQueryID()
      Unique identifier for the query. This is used for [click analytics](https://www.algolia.com/doc/guides/analytics/click-analytics/).

    • setAutomaticInsights

      public BrowseResponse<T> setAutomaticInsights(Boolean automaticInsights)

    • getAutomaticInsights

      @Nullable public Boolean getAutomaticInsights()
      Whether automatic events collection is enabled for the application.

    • setPage

      public BrowseResponse<T> setPage(Integer page)

    • getPage

      @Nullable public Integer getPage()
      Page of search results to retrieve. minimum: 0

    • setNbHits

      public BrowseResponse<T> setNbHits(Integer nbHits)

    • getNbHits

      @Nullable public Integer getNbHits()
      Number of results (hits).

    • setNbPages

      public BrowseResponse<T> setNbPages(Integer nbPages)

    • getNbPages

      @Nullable public Integer getNbPages()
      Number of pages of results.

    • setHitsPerPage

      public BrowseResponse<T> setHitsPerPage(Integer hitsPerPage)

    • getHitsPerPage

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

    • setHits

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

    • addHits

      public BrowseResponse<T> addHits(T hitsItem)

    • getHits

      @Nonnull public List<T> getHits()
      Search results (hits). Hits are records from your index that match the search criteria, augmented with additional attributes, such as, for highlighting.

    • setQuery

      public BrowseResponse<T> setQuery(String query)

    • getQuery

      @Nonnull public String getQuery()
      Search query.

    • 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 to get the next page of the response. The parameter must match the value returned in the response of a previous request. The last page of the response does not return a `cursor` attribute.

    • 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