Package com.algolia.model.recommend

Class SearchRecommendRulesParams

java.lang.Object

com.algolia.model.recommend.SearchRecommendRulesParams

public class SearchRecommendRulesParams
extends Object

Recommend rules parameters.

Constructor Summary

Constructors

Constructor	Description
SearchRecommendRulesParams()

Method Summary

Modifier and Type	Method	Description
SearchRecommendRulesParams	addFacets(String facetsItem)
boolean	equals(Object o)
String	getContext()	Only search for rules with matching context.
Boolean	getEnabled()	Whether to only show rules where the value of their `enabled` property matches this parameter.
List<String>	getFacets()	Include facets and facet values in the response.
String	getFilters()	Filter expression.
Integer	getHitsPerPage()	Maximum number of hits per page.
Integer	getMaxValuesPerFacet()	Maximum number of values to return for each facet.
Integer	getPage()	Requested page of the API response.
String	getQuery()	Search query.
int	hashCode()
SearchRecommendRulesParams	setContext(String context)
SearchRecommendRulesParams	setEnabled(Boolean enabled)
SearchRecommendRulesParams	setFacets(List<String> facets)
SearchRecommendRulesParams	setFilters(String filters)
SearchRecommendRulesParams	setHitsPerPage(Integer hitsPerPage)
SearchRecommendRulesParams	setMaxValuesPerFacet(Integer maxValuesPerFacet)
SearchRecommendRulesParams	setPage(Integer page)
SearchRecommendRulesParams	setQuery(String query)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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. minimum: 0

setHitsPerPage

public SearchRecommendRulesParams setHitsPerPage(Integer hitsPerPage)

getHitsPerPage

@Nullable
public Integer getHitsPerPage()

Maximum number of hits per page. 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