Package com.algolia.model.search

Class Exhaustive

java.lang.Object
com.algolia.model.search.Exhaustive
public class Exhaustive extends Object
Whether certain properties of the search response are calculated exhaustive (exact) or approximated.

  • Constructor Details

    • Exhaustive

      public Exhaustive()

  • Method Details

    • setFacetsCount

      public Exhaustive setFacetsCount(Boolean facetsCount)

    • getFacetsCount

      @Nullable public Boolean getFacetsCount()
      Whether the facet count is exhaustive (`true`) or approximate (`false`). See the [related discussion](https://support.algolia.com/hc/en-us/articles/4406975248145-Why-are-my-facet-and-hit-counts-not-accurate-).

    • setFacetValues

      public Exhaustive setFacetValues(Boolean facetValues)

    • getFacetValues

      @Nullable public Boolean getFacetValues()
      The value is `false` if not all facet values are retrieved.

    • setNbHits

      public Exhaustive setNbHits(Boolean nbHits)

    • getNbHits

      @Nullable public Boolean getNbHits()
      Whether the `nbHits` is exhaustive (`true`) or approximate (`false`). When the query takes more than 50ms to be processed, the engine makes an approximation. This can happen when using complex filters on millions of records, when typo-tolerance was not exhaustive, or when enough hits have been retrieved (for example, after the engine finds 10,000 exact matches). `nbHits` is reported as non-exhaustive whenever an approximation is made, even if the approximation didn’t, in the end, impact the exhaustivity of the query.

    • setRulesMatch

      public Exhaustive setRulesMatch(Boolean rulesMatch)

    • getRulesMatch

      @Nullable public Boolean getRulesMatch()
      Rules matching exhaustivity. The value is `false` if rules were enable for this query, and could not be fully processed due a timeout. This is generally caused by the number of alternatives (such as typos) which is too large.

    • setTypo

      public Exhaustive setTypo(Boolean typo)

    • getTypo

      @Nullable public Boolean getTypo()
      Whether the typo search was exhaustive (`true`) or approximate (`false`). An approximation is done when the typo search query part takes more than 10% of the query budget (ie. 5ms by default) to be processed (this can happen when a lot of typo alternatives exist for the query). This field will not be included when typo-tolerance is entirely disabled.

    • 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