Package com.commercetools.ml.models.similar_products

Interface SimilarProductSearchRequest

All Known Implementing Classes:
SimilarProductSearchRequestImpl
public interface SimilarProductSearchRequest
SimilarProductSearchRequest
Example to create an instance using the builder pattern 

     SimilarProductSearchRequest similarProductSearchRequest = SimilarProductSearchRequest.builder()
             .build()

  • Method Details

    • getLimit

      Long getLimit()

      Number of results requested.

      Returns:
      limit

    • getOffset

      Long getOffset()

      Number of elements skipped.

      Returns:
      offset

    • getLanguage

      String getLanguage()

      language tag used to prioritize language for text comparisons.

      Returns:
      language

    • getCurrencyCode

      String getCurrencyCode()

      The three-digit currency code to compare prices in. When a product has multiple prices, all prices for the product are converted to the currency provided by the currency attribute and the median price is calculated for comparison. Currencies are converted using the ECB currency exchange rates at the time the request is made. Of the currency codes, only currencies with currency exchange rates provided by the ECB are supported.

      Returns:
      currencyCode

    • getSimilarityMeasures

      @Valid @Valid SimilarityMeasures getSimilarityMeasures()

      similarityMeasures defines the attributes taken into account to measure product similarity.

      Returns:
      similarityMeasures

    • getProductSetSelectors

      @Valid @Valid List<ProductSetSelector> getProductSetSelectors()

      Array of length 2 of ProductSetSelector

      Returns:
      productSetSelectors

    • getConfidenceMin

      Double getConfidenceMin()
      Returns:
      confidenceMin

    • getConfidenceMax

      Double getConfidenceMax()
      Returns:
      confidenceMax

    • setLimit

      void setLimit(Long limit)

      Number of results requested.

      Parameters:
      limit - value to be set

    • setOffset

      void setOffset(Long offset)

      Number of elements skipped.

      Parameters:
      offset - value to be set

    • setLanguage

      void setLanguage(String language)

      language tag used to prioritize language for text comparisons.

      Parameters:
      language - value to be set

    • setCurrencyCode

      void setCurrencyCode(String currencyCode)

      The three-digit currency code to compare prices in. When a product has multiple prices, all prices for the product are converted to the currency provided by the currency attribute and the median price is calculated for comparison. Currencies are converted using the ECB currency exchange rates at the time the request is made. Of the currency codes, only currencies with currency exchange rates provided by the ECB are supported.

      Parameters:
      currencyCode - value to be set

    • setSimilarityMeasures

      void setSimilarityMeasures(SimilarityMeasures similarityMeasures)

      similarityMeasures defines the attributes taken into account to measure product similarity.

      Parameters:
      similarityMeasures - value to be set

    • setProductSetSelectors

      void setProductSetSelectors(ProductSetSelector... productSetSelectors)

      Array of length 2 of ProductSetSelector

      Parameters:
      productSetSelectors - values to be set

    • setProductSetSelectors

      void setProductSetSelectors(List<ProductSetSelector> productSetSelectors)

      Array of length 2 of ProductSetSelector

      Parameters:
      productSetSelectors - values to be set

    • setConfidenceMin

      void setConfidenceMin(Double confidenceMin)
      set confidenceMin
      Parameters:
      confidenceMin - value to be set

    • setConfidenceMax

      void setConfidenceMax(Double confidenceMax)
      set confidenceMax
      Parameters:
      confidenceMax - value to be set

    • of

      static SimilarProductSearchRequest of()
      factory method
      Returns:
      instance of SimilarProductSearchRequest

    • of

      static SimilarProductSearchRequest of(SimilarProductSearchRequest template)
      factory method to create a shallow copy SimilarProductSearchRequest
      Parameters:
      template - instance to be copied
      Returns:
      copy instance

    • deepCopy

      @Nullable static SimilarProductSearchRequest deepCopy(@Nullable SimilarProductSearchRequest template)
      factory method to create a deep copy of SimilarProductSearchRequest
      Parameters:
      template - instance to be copied
      Returns:
      copy instance

    • builder

      static SimilarProductSearchRequestBuilder builder()
      builder factory method for SimilarProductSearchRequest
      Returns:
      builder

    • builder

      static SimilarProductSearchRequestBuilder builder(SimilarProductSearchRequest template)
      create builder for SimilarProductSearchRequest instance
      Parameters:
      template - instance with prefilled values for the builder
      Returns:
      builder

    • withSimilarProductSearchRequest

      default <T> T withSimilarProductSearchRequest(Function<SimilarProductSearchRequest,T> helper)
      accessor map function
      Type Parameters:
      T - mapped type
      Parameters:
      helper - function to map the object
      Returns:
      mapped value

    • typeReference

      static com.fasterxml.jackson.core.type.TypeReference<SimilarProductSearchRequest> typeReference()
      gives a TypeReference for usage with Jackson DataBind
      Returns:
      TypeReference