public interface MissingImagesSearchRequest
| Modifier and Type | Method and Description |
|---|---|
static MissingImagesSearchRequestBuilder |
builder() |
static MissingImagesSearchRequestBuilder |
builder(MissingImagesSearchRequest template) |
Boolean |
getAutoThreshold()
If true, uses the median number of images per product variant as a threshold value.
|
Boolean |
getIncludeVariants()
If true, searches all product variants.
|
Long |
getLimit() |
Long |
getOffset() |
List<String> |
getProductIds()
Filters results by the provided Product IDs.
|
Long |
getProductSetLimit()
Maximum number of products to scan.
|
List<String> |
getProductTypeIds()
Filters results by the provided product type IDs.
|
Boolean |
getStaged()
If true, searches data from staged products in addition to published products.
|
Long |
getThreshold()
The minimum number of images a product variant must have.
|
static MissingImagesSearchRequest |
of() |
static MissingImagesSearchRequest |
of(MissingImagesSearchRequest template) |
void |
setAutoThreshold(Boolean autoThreshold) |
void |
setIncludeVariants(Boolean includeVariants) |
void |
setLimit(Long limit) |
void |
setOffset(Long offset) |
void |
setProductIds(List<String> productIds) |
void |
setProductIds(String... productIds) |
void |
setProductSetLimit(Long productSetLimit) |
void |
setProductTypeIds(List<String> productTypeIds) |
void |
setProductTypeIds(String... productTypeIds) |
void |
setStaged(Boolean staged) |
void |
setThreshold(Long threshold) |
default <T> T |
withMissingImagesSearchRequest(Function<MissingImagesSearchRequest,T> helper) |
Long getLimit()
Long getOffset()
Boolean getStaged()
If true, searches data from staged products in addition to published products.
Long getProductSetLimit()
Maximum number of products to scan.
Boolean getIncludeVariants()
If true, searches all product variants. If false, only searches master variants.
Boolean getAutoThreshold()
If true, uses the median number of images per product variant as a threshold value.
Long getThreshold()
The minimum number of images a product variant must have. Anything below this value is considered a product variant with missing images.
List<String> getProductIds()
Filters results by the provided Product IDs. Cannot be applied in combination with any other filter.
List<String> getProductTypeIds()
Filters results by the provided product type IDs. It cannot be applied in combination with any other filter.
void setLimit(Long limit)
void setOffset(Long offset)
void setStaged(Boolean staged)
void setProductSetLimit(Long productSetLimit)
void setIncludeVariants(Boolean includeVariants)
void setAutoThreshold(Boolean autoThreshold)
void setThreshold(Long threshold)
void setProductIds(String... productIds)
void setProductTypeIds(String... productTypeIds)
static MissingImagesSearchRequest of()
static MissingImagesSearchRequest of(MissingImagesSearchRequest template)
static MissingImagesSearchRequestBuilder builder()
static MissingImagesSearchRequestBuilder builder(MissingImagesSearchRequest template)
default <T> T withMissingImagesSearchRequest(Function<MissingImagesSearchRequest,T> helper)