Package com.commercetools.ml.models.similar_products

Class ProductSetSelectorBuilder

java.lang.Object
com.commercetools.ml.models.similar_products.ProductSetSelectorBuilder
All Implemented Interfaces:
Builder<ProductSetSelector>
public class ProductSetSelectorBuilder extends Object implements Builder<ProductSetSelector>
ProductSetSelectorBuilder
Example to create an instance using the builder pattern 

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

  • Constructor Details

    • ProductSetSelectorBuilder

      public ProductSetSelectorBuilder()

  • Method Details

    • projectKey

      public ProductSetSelectorBuilder projectKey(String projectKey)

      The project containing the project set.

      Parameters:
      projectKey - value to be set
      Returns:
      Builder

    • productIds

      public ProductSetSelectorBuilder productIds(@Nullable String... productIds)

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

      Parameters:
      productIds - value to be set
      Returns:
      Builder

    • productIds

      public ProductSetSelectorBuilder productIds(@Nullable List<String> productIds)

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

      Parameters:
      productIds - value to be set
      Returns:
      Builder

    • plusProductIds

      public ProductSetSelectorBuilder plusProductIds(@Nullable String... productIds)

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

      Parameters:
      productIds - value to be set
      Returns:
      Builder

    • productTypeIds

      public ProductSetSelectorBuilder productTypeIds(@Nullable 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 - value to be set
      Returns:
      Builder

    • productTypeIds

      public ProductSetSelectorBuilder productTypeIds(@Nullable 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 - value to be set
      Returns:
      Builder

    • plusProductTypeIds

      public ProductSetSelectorBuilder plusProductTypeIds(@Nullable 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 - value to be set
      Returns:
      Builder

    • staged

      public ProductSetSelectorBuilder staged(@Nullable Boolean staged)

      Specifies use of staged or current product data.

      Parameters:
      staged - value to be set
      Returns:
      Builder

    • includeVariants

      public ProductSetSelectorBuilder includeVariants(@Nullable 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
      Returns:
      Builder

    • productSetLimit

      public ProductSetSelectorBuilder productSetLimit(@Nullable 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
      Returns:
      Builder

    • getProjectKey

      public String getProjectKey()

      The project containing the project set.

      Returns:
      projectKey

    • getProductIds

      @Nullable public List<String> getProductIds()

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

      Returns:
      productIds

    • getProductTypeIds

      @Nullable public 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

      @Nullable public Boolean getStaged()

      Specifies use of staged or current product data.

      Returns:
      staged

    • getIncludeVariants

      @Nullable public Boolean getIncludeVariants()

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

      Returns:
      includeVariants

    • getProductSetLimit

      @Nullable public 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

    • build

      public ProductSetSelector build()
      builds ProductSetSelector with checking for non-null required values
      Specified by:
      build in interface Builder<ProductSetSelector>
      Returns:
      ProductSetSelector

    • buildUnchecked

      public ProductSetSelector buildUnchecked()
      builds ProductSetSelector without checking for non-null required values
      Returns:
      ProductSetSelector

    • of

      public static ProductSetSelectorBuilder of()
      factory method for an instance of ProductSetSelectorBuilder
      Returns:
      builder

    • of

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