com.commercetools.ml.models.similar_products

Class ProductSetSelectorBuilder

java.lang.Object

com.commercetools.ml.models.similar_products.ProductSetSelectorBuilder

All Implemented Interfaces:

io.vrap.rmf.base.client.Builder<ProductSetSelector>

public class ProductSetSelectorBuilder
extends Object
implements io.vrap.rmf.base.client.Builder<ProductSetSelector>

ProductSetSelectorBuilder Example to create an instance using the builder pattern

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

Constructor Summary

Constructors

Constructor and Description
ProductSetSelectorBuilder()

Method Summary

Modifier and Type	Method and Description
ProductSetSelector	build()
ProductSetSelector	buildUnchecked() builds ProductSetSelector without checking for non null required values
Boolean	getIncludeVariants()
List<String>	getProductIds()
Long	getProductSetLimit()
List<String>	getProductTypeIds()
String	getProjectKey()
Boolean	getStaged()
ProductSetSelectorBuilder	includeVariants(Boolean includeVariants) Specifies use of product variants.
static ProductSetSelectorBuilder	of()
static ProductSetSelectorBuilder	of(ProductSetSelector template)
ProductSetSelectorBuilder	plusProductIds(String... productIds) An array of Product IDs to compare.
ProductSetSelectorBuilder	plusProductTypeIds(String... productTypeIds) An array of product type IDs.
ProductSetSelectorBuilder	productIds(List<String> productIds) An array of Product IDs to compare.
ProductSetSelectorBuilder	productIds(String... productIds) An array of Product IDs to compare.
ProductSetSelectorBuilder	productSetLimit(Long productSetLimit) Maximum number of products to check (if unspecified, all products are considered).
ProductSetSelectorBuilder	productTypeIds(List<String> productTypeIds) An array of product type IDs.
ProductSetSelectorBuilder	productTypeIds(String... productTypeIds) An array of product type IDs.
ProductSetSelectorBuilder	projectKey(String projectKey) The project containing the project set.
ProductSetSelectorBuilder	staged(Boolean staged) Specifies use of staged or current product data.

Methods inherited from class java.lang.Object

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

Constructor Detail

ProductSetSelectorBuilder

public ProductSetSelectorBuilder()

Method Detail

projectKey

public ProductSetSelectorBuilder projectKey(String projectKey)

The project containing the project set.

productIds

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

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

productIds

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

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

plusProductIds

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

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

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.

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.

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.

staged

public ProductSetSelectorBuilder staged(@Nullable
                                        Boolean staged)

Specifies use of staged or current product data.

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.

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

getProjectKey

public String getProjectKey()

getProductIds

@Nullable
public List<String> getProductIds()

getProductTypeIds

@Nullable
public List<String> getProductTypeIds()

getStaged

@Nullable
public Boolean getStaged()

getIncludeVariants

@Nullable
public Boolean getIncludeVariants()

getProductSetLimit

@Nullable
public Long getProductSetLimit()

build

public ProductSetSelector build()

Specified by:

build in interface io.vrap.rmf.base.client.Builder<ProductSetSelector>

buildUnchecked

public ProductSetSelector buildUnchecked()

builds ProductSetSelector without checking for non null required values

of

public static ProductSetSelectorBuilder of()

of

public static ProductSetSelectorBuilder of(ProductSetSelector template)