Package com.algolia.search.models.recommend

Class RecommendationsQuery

java.lang.Object

com.algolia.search.models.recommend.RecommendationsQuery

public class RecommendationsQuery
extends Object

Constructor Summary

Constructors

Constructor	Description
RecommendationsQuery(String indexName, String model, String objectID)	Recommendation query options.

Method Summary

Modifier and Type	Method	Description
Query	getFallbackParameters()
String	getIndexName()
Integer	getMaxRecommendations()
String	getModel()
String	getObjectID()
Query	getQueryParameters()
Integer	getThreshold()
RecommendationsQuery	setFallbackParameters(Query fallbackParameters)
RecommendationsQuery	setMaxRecommendations(Integer maxRecommendations)
com.algolia.search.models.recommend.RecommendationsOptions	setObjectID(String objectID)
RecommendationsQuery	setQueryParameters(Query queryParameters)
RecommendationsQuery	setThreshold(Integer threshold)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RecommendationsQuery

public RecommendationsQuery(@Nonnull
                            String indexName,
                            @Nonnull
                            String model,
                            @Nonnull
                            String objectID)

Recommendation query options.

Parameters:

indexName - name of the index to target.

model - the recommendation model to use, on of: "related-products", or "bought-together"

objectID - the objectID to get recommendations for

Method Detail

getIndexName

public String getIndexName()

getModel

public String getModel()

getObjectID

public String getObjectID()

setObjectID

public com.algolia.search.models.recommend.RecommendationsOptions setObjectID(@Nonnull
                                                                              String objectID)

getThreshold

public Integer getThreshold()

setThreshold

public RecommendationsQuery setThreshold(@Nonnull
                                         Integer threshold)

getMaxRecommendations

public Integer getMaxRecommendations()

setMaxRecommendations

public RecommendationsQuery setMaxRecommendations(Integer maxRecommendations)

getQueryParameters

public Query getQueryParameters()

setQueryParameters

public RecommendationsQuery setQueryParameters(@Nonnull
                                               Query queryParameters)

getFallbackParameters

public Query getFallbackParameters()

setFallbackParameters

public RecommendationsQuery setFallbackParameters(@Nonnull
                                                  Query fallbackParameters)