Package com.algolia.model.search

Class SearchRulesParams

java.lang.Object
com.algolia.model.search.SearchRulesParams
public class SearchRulesParams extends Object
Rules search parameters.

  • Constructor Details

    • SearchRulesParams

      public SearchRulesParams()

  • Method Details

    • setQuery

      public SearchRulesParams setQuery(String query)

    • getQuery

      @Nullable public String getQuery()
      Rule object query.
      Returns:
      query

    • setAnchoring

      public SearchRulesParams setAnchoring(Anchoring anchoring)

    • getAnchoring

      @Nullable public Anchoring getAnchoring()
      Get anchoring
      Returns:
      anchoring

    • setContext

      public SearchRulesParams setContext(String context)

    • getContext

      @Nullable public String getContext()
      Restricts responses to the specified [contextual rule](https://www.algolia.com/doc/guides/managing-results/rules/rules-overview/how-to/customize-search-results-by-platform/#creating-contextual-rules).
      Returns:
      context

    • setPage

      public SearchRulesParams setPage(Integer page)

    • getPage

      @Nullable public Integer getPage()
      Requested page (the first page is page 0). minimum: 0
      Returns:
      page

    • setHitsPerPage

      public SearchRulesParams setHitsPerPage(Integer hitsPerPage)

    • getHitsPerPage

      @Nullable public Integer getHitsPerPage()
      Maximum number of hits per page. minimum: 1 maximum: 1000
      Returns:
      hitsPerPage

    • setEnabled

      public SearchRulesParams setEnabled(Boolean enabled)

    • getEnabled

      @Nullable public Boolean getEnabled()
      Restricts responses to enabled rules. When not specified (default), _all_ rules are retrieved.
      Returns:
      enabled

    • setRequestOptions

      public SearchRulesParams setRequestOptions(List<Object> requestOptions)

    • addRequestOptions

      public SearchRulesParams addRequestOptions(Object requestOptionsItem)

    • getRequestOptions

      @Nullable public List<Object> getRequestOptions()
      Request options to send with the API call.
      Returns:
      requestOptions

    • 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