Package com.algolia.model.search

Class SearchForFacetsOptions

java.lang.Object
com.algolia.model.search.SearchForFacetsOptions
public class SearchForFacetsOptions extends Object
SearchForFacetsOptions

  • Constructor Details

    • SearchForFacetsOptions

      public SearchForFacetsOptions()

  • Method Details

    • setFacet

      public SearchForFacetsOptions setFacet(String facet)

    • getFacet

      @Nonnull public String getFacet()
      Facet name.
      Returns:
      facet

    • setIndexName

      public SearchForFacetsOptions setIndexName(String indexName)

    • getIndexName

      @Nonnull public String getIndexName()
      Algolia index name.
      Returns:
      indexName

    • setFacetQuery

      public SearchForFacetsOptions setFacetQuery(String facetQuery)

    • getFacetQuery

      @Nullable public String getFacetQuery()
      Text to search inside the facet's values.
      Returns:
      facetQuery

    • setMaxFacetHits

      public SearchForFacetsOptions setMaxFacetHits(Integer maxFacetHits)

    • getMaxFacetHits

      @Nullable public Integer getMaxFacetHits()
      Maximum number of facet hits to return when [searching for facet values](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#search-for-facet-values). maximum: 100
      Returns:
      maxFacetHits

    • setType

      public SearchForFacetsOptions setType(SearchTypeFacet type)

    • getType

      @Nonnull public SearchTypeFacet getType()
      Get type
      Returns:
      type

    • 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