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()
      Search query for rules.
    • setAnchoring

      public SearchRulesParams setAnchoring(Anchoring anchoring)
    • getAnchoring

      @Nullable public Anchoring getAnchoring()
      Get anchoring
    • setContext

      public SearchRulesParams setContext(String context)
    • getContext

      @Nullable public String getContext()
      Only return rules that match the context (exact match).
    • setPage

      public SearchRulesParams setPage(Integer page)
    • getPage

      @Nullable public Integer getPage()
      Requested page of the API response. minimum: 0
    • setHitsPerPage

      public SearchRulesParams setHitsPerPage(Integer hitsPerPage)
    • getHitsPerPage

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

      public SearchRulesParams setEnabled(Boolean enabled)
    • getEnabled

      @Nullable public Boolean getEnabled()
      If `true`, return only enabled rules. If `false`, return only inactive rules. By default, _all_ rules are returned.
    • 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