Package com.commercetools.ml.models.similar_products

Interface ProductSetSelector

public interface ProductSetSelector

A set of ProductData for comparison. If no optional attributes are specified, all current ProductData are selected for comparison.

Example to create an instance using the builder pattern 

     ProductSetSelector productSetSelector = ProductSetSelector.builder()
             .projectKey("{projectKey}")
             .build()

  • Method Details

    • getProjectKey

      @NotNull @NotNull String getProjectKey()

      The project containing the project set.

      Returns:
      projectKey

    • getProductIds

      List<String> getProductIds()

      An array of Product IDs to compare. If unspecified, no Product ID filter is applied.

      Returns:
      productIds

    • getProductTypeIds

      List<String> getProductTypeIds()

      An array of product type IDs. Only products with product types in this array are compared. If unspecified, no product type filter is applied.

      Returns:
      productTypeIds

    • getStaged

      Boolean getStaged()

      Specifies use of staged or current product data.

      Returns:
      staged

    • getIncludeVariants

      Boolean getIncludeVariants()

      Specifies use of product variants. If set to true, all product variants are compared, not just the master variant.

      Returns:
      includeVariants

    • getProductSetLimit

      Long getProductSetLimit()

      Maximum number of products to check (if unspecified, all products are considered). Note that the maximum number of product comparisons between two productSets is 20,000,000. This limit cannot be exceeded. If you need a higher limit, contact https://support.commercetools.com

      Returns:
      productSetLimit

    • setProjectKey

      void setProjectKey(String projectKey)

      The project containing the project set.

      Parameters:
      projectKey - value to be set

    • setProductIds

      void setProductIds(String... productIds)

      An array of Product IDs to compare. If unspecified, no Product ID filter is applied.

      Parameters:
      productIds - values to be set

    • setProductIds

      void setProductIds(List<String> productIds)

      An array of Product IDs to compare. If unspecified, no Product ID filter is applied.

      Parameters:
      productIds - values to be set

    • setProductTypeIds

      void setProductTypeIds(String... productTypeIds)

      An array of product type IDs. Only products with product types in this array are compared. If unspecified, no product type filter is applied.

      Parameters:
      productTypeIds - values to be set

    • setProductTypeIds

      void setProductTypeIds(List<String> productTypeIds)

      An array of product type IDs. Only products with product types in this array are compared. If unspecified, no product type filter is applied.

      Parameters:
      productTypeIds - values to be set

    • setStaged

      void setStaged(Boolean staged)

      Specifies use of staged or current product data.

      Parameters:
      staged - value to be set

    • setIncludeVariants

      void setIncludeVariants(Boolean includeVariants)

      Specifies use of product variants. If set to true, all product variants are compared, not just the master variant.

      Parameters:
      includeVariants - value to be set

    • setProductSetLimit

      void setProductSetLimit(Long productSetLimit)

      Maximum number of products to check (if unspecified, all products are considered). Note that the maximum number of product comparisons between two productSets is 20,000,000. This limit cannot be exceeded. If you need a higher limit, contact https://support.commercetools.com

      Parameters:
      productSetLimit - value to be set

    • of

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

    • of

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

    • deepCopy

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

    • builder

      static ProductSetSelectorBuilder builder()
      builder factory method for ProductSetSelector
      Returns:
      builder

    • builder

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

    • withProductSetSelector

      default <T> T withProductSetSelector(Function<ProductSetSelector,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<ProductSetSelector> typeReference()
      gives a TypeReference for usage with Jackson DataBind
      Returns:
      TypeReference