Package com.algolia.model.recommend

Class SearchRecommendRulesParams

java.lang.Object
com.algolia.model.recommend.SearchRecommendRulesParams
public class SearchRecommendRulesParams extends Object
Recommend rules parameters.

  • Constructor Details

    • SearchRecommendRulesParams

      public SearchRecommendRulesParams()

  • Method Details

    • setQuery

      public SearchRecommendRulesParams setQuery(String query)

    • getQuery

      @Nullable public String getQuery()
      Search query.

    • setContext

      public SearchRecommendRulesParams setContext(String context)

    • getContext

      @Nullable public String getContext()
      Only search for rules with matching context.

    • setPage

      public SearchRecommendRulesParams setPage(Integer page)

    • getPage

      @Nullable public Integer getPage()
      Requested page of the API response. Algolia uses `page` and `hitsPerPage` to control how search results are displayed ([paginated](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/pagination/js/)). - `hitsPerPage`: sets the number of search results (_hits_) displayed per page. - `page`: specifies the page number of the search results you want to retrieve. Page numbering starts at 0, so the first page is `page=0`, the second is `page=1`, and so on. For example, to display 10 results per page starting from the third page, set `hitsPerPage` to 10 and `page` to 2. minimum: 0

    • setHitsPerPage

      public SearchRecommendRulesParams setHitsPerPage(Integer hitsPerPage)

    • getHitsPerPage

      @Nullable public Integer getHitsPerPage()
      Maximum number of hits per page. Algolia uses `page` and `hitsPerPage` to control how search results are displayed ([paginated](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/pagination/js/)). - `hitsPerPage`: sets the number of search results (_hits_) displayed per page. - `page`: specifies the page number of the search results you want to retrieve. Page numbering starts at 0, so the first page is `page=0`, the second is `page=1`, and so on. For example, to display 10 results per page starting from the third page, set `hitsPerPage` to 10 and `page` to 2. minimum: 1 maximum: 1000

    • setEnabled

      public SearchRecommendRulesParams setEnabled(Boolean enabled)

    • getEnabled

      @Nullable public Boolean getEnabled()
      Whether to only show rules where the value of their `enabled` property matches this parameter. If absent, show all rules, regardless of their `enabled` property.

    • setFilters

      public SearchRecommendRulesParams setFilters(String filters)

    • getFilters

      @Nullable public String getFilters()
      Filter expression. This only searches for rules matching the filter expression.

    • setFacets

      public SearchRecommendRulesParams setFacets(List<String> facets)

    • addFacets

      public SearchRecommendRulesParams addFacets(String facetsItem)

    • getFacets

      @Nullable public List<String> getFacets()
      Include facets and facet values in the response. Use `['*']` to include all facets.

    • setMaxValuesPerFacet

      public SearchRecommendRulesParams setMaxValuesPerFacet(Integer maxValuesPerFacet)

    • getMaxValuesPerFacet

      @Nullable public Integer getMaxValuesPerFacet()
      Maximum number of values to return for each facet. minimum: 1 maximum: 1000

    • 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