public interface ProductSetSelector
A set of ProductData for comparison. If no optional attributes are specified, all current ProductData are selected for comparison.
ProductSetSelector productSetSelector = ProductSetSelector.builder()
.projectKey("{projectKey}")
.build()
| Modifier and Type | Method and Description |
|---|---|
static ProductSetSelectorBuilder |
builder() |
static ProductSetSelectorBuilder |
builder(ProductSetSelector template) |
Boolean |
getIncludeVariants()
Specifies use of product variants.
|
List<String> |
getProductIds()
An array of Product IDs to compare.
|
Long |
getProductSetLimit()
Maximum number of products to check (if unspecified, all products are considered).
|
List<String> |
getProductTypeIds()
An array of product type IDs.
|
@NotNull String |
getProjectKey()
The project containing the project set.
|
Boolean |
getStaged()
Specifies use of staged or current product data.
|
static ProductSetSelector |
of() |
static ProductSetSelector |
of(ProductSetSelector template) |
void |
setIncludeVariants(Boolean includeVariants) |
void |
setProductIds(List<String> productIds) |
void |
setProductIds(String... productIds) |
void |
setProductSetLimit(Long productSetLimit) |
void |
setProductTypeIds(List<String> productTypeIds) |
void |
setProductTypeIds(String... productTypeIds) |
void |
setProjectKey(String projectKey) |
void |
setStaged(Boolean staged) |
static com.fasterxml.jackson.core.type.TypeReference<ProductSetSelector> |
typeReference() |
default <T> T |
withProductSetSelector(Function<ProductSetSelector,T> helper) |
@NotNull @NotNull String getProjectKey()
The project containing the project set.
List<String> getProductIds()
An array of Product IDs to compare. If unspecified, no Product ID filter is applied.
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.
Boolean getIncludeVariants()
Specifies use of product variants. If set to true, all product variants are compared, not just the master variant.
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
void setProjectKey(String projectKey)
void setProductIds(String... productIds)
void setProductIds(List<String> productIds)
void setProductTypeIds(String... productTypeIds)
void setProductTypeIds(List<String> productTypeIds)
void setIncludeVariants(Boolean includeVariants)
void setProductSetLimit(Long productSetLimit)
static ProductSetSelector of()
static ProductSetSelector of(ProductSetSelector template)
static ProductSetSelectorBuilder builder()
static ProductSetSelectorBuilder builder(ProductSetSelector template)
default <T> T withProductSetSelector(Function<ProductSetSelector,T> helper)
static com.fasterxml.jackson.core.type.TypeReference<ProductSetSelector> typeReference()