Class

algolia.objects

RelatedProductsQuery

Related Doc: package objects

Permalink

case class RelatedProductsQuery(indexName: String, objectID: String, threshold: Int = 0, maxRecommendations: Option[Int] = None, queryParameters: Option[Query] = None, fallbackParameters: Option[Query] = None) extends RecommendationsOptions with Product with Serializable

Linear Supertypes
Serializable, Serializable, Product, Equals, RecommendationsOptions, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. RelatedProductsQuery
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. RecommendationsOptions
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new RelatedProductsQuery(indexName: String, objectID: String, threshold: Int = 0, maxRecommendations: Option[Int] = None, queryParameters: Option[Query] = None, fallbackParameters: Option[Query] = None)

    Permalink

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  5. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @throws( ... )

  6. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  7. val fallbackParameters: Option[Query]

    Permalink

    Search parameters to use as fallback when there are no recommendations

    Search parameters to use as fallback when there are no recommendations

    Definition Classes
    RelatedProductsQuery → RecommendationsOptions

  8. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate()

  9. val indexName: String

    Permalink

    Name of the index to target

    Name of the index to target

    Definition Classes
    RelatedProductsQuery → RecommendationsOptions

  10. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  11. val maxRecommendations: Option[Int]

    Permalink

    The maximum number of recommendations to retrieve

    The maximum number of recommendations to retrieve

    Definition Classes
    RelatedProductsQuery → RecommendationsOptions

  12. val model: String

    Permalink

    The recommendation model to use

    The recommendation model to use

    Definition Classes
    RelatedProductsQuery → RecommendationsOptions

  13. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  14. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()

  15. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()

  16. val objectID: String

    Permalink

    The object ID to get recommendations for

    The object ID to get recommendations for

    Definition Classes
    RelatedProductsQuery → RecommendationsOptions

  17. val queryParameters: Option[Query]

    Permalink

    Search parameters to filter the recommendations

    Search parameters to filter the recommendations

    Definition Classes
    RelatedProductsQuery → RecommendationsOptions

  18. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef

  19. val threshold: Int

    Permalink

    The threshold to use when filtering recommendations by their score, default 0, between 0 and 100

    The threshold to use when filtering recommendations by their score, default 0, between 0 and 100

    Definition Classes
    RelatedProductsQuery → RecommendationsOptions

  20. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  21. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  22. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @Deprecated @deprecated @throws( classOf[java.lang.Throwable] )
    Deprecated

    (Since version ) see corresponding Javadoc for more information.

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from RecommendationsOptions

Inherited from AnyRef

Inherited from Any

Ungrouped