MissingAttributesSearchRequest (commercetools-sdk-java-ml 3.1.0 API)

All Known Implementing Classes:

MissingAttributesSearchRequestImpl
```
public interface MissingAttributesSearchRequest
```

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`static MissingAttributesSearchRequestBuilder`	`builder()`
`static MissingAttributesSearchRequestBuilder`	`builder(MissingAttributesSearchRequest template)`
`String`	`getAttributeName()` Filters results by the provided attribute name.
`Double`	`getCoverageMax()` Maximum attribute coverage of variants to display, applied to both coverage types.
`Double`	`getCoverageMin()` Minimum attribute coverage of variants to display, applied to both coverage types.
`Boolean`	`getIncludeVariants()` If true, searches all product variants.
`Integer`	`getLimit()`
`Integer`	`getOffset()`
`List<String>`	`getProductIds()` Filters results by the provided Product IDs.
`Integer`	`getProductSetLimit()` Maximum number of products to scan.
`List<String>`	`getProductTypeIds()` Filters results by the provided product type IDs.
`Boolean`	`getShowMissingAttributeNames()` If true, the `missingAttributeNames` will be included in the results.
`String`	`getSortBy()` Default value: `coverageAttributeValues` - Allowed values: [`coverageAttributeValues`, `coverageAttributeNames`] `coverageAttributeValues` shows the product variants with the most missing attribute values first and `coverageAttributeNames` the ones with the most missing attribute names.
`Boolean`	`getStaged()` If true, searches data from staged products in addition to published products.
`static MissingAttributesSearchRequest`	`of()`
`static MissingAttributesSearchRequest`	`of(MissingAttributesSearchRequest template)`
`void`	`setAttributeName(String attributeName)`
`void`	`setCoverageMax(Double coverageMax)`
`void`	`setCoverageMin(Double coverageMin)`
`void`	`setIncludeVariants(Boolean includeVariants)`
`void`	`setLimit(Integer limit)`
`void`	`setOffset(Integer offset)`
`void`	`setProductIds(List<String> productIds)`
`void`	`setProductIds(String... productIds)`
`void`	`setProductSetLimit(Integer productSetLimit)`
`void`	`setProductTypeIds(List<String> productTypeIds)`
`void`	`setProductTypeIds(String... productTypeIds)`
`void`	`setShowMissingAttributeNames(Boolean showMissingAttributeNames)`
`void`	`setSortBy(String sortBy)`
`void`	`setStaged(Boolean staged)`
`default <T> T`	`withMissingAttributesSearchRequest(Function<MissingAttributesSearchRequest,T> helper)`

- Method Detail
  - getLimit
```
Integer getLimit()
```
  - getOffset
```
Integer getOffset()
```
  - getStaged
```
Boolean getStaged()
```
    If true, searches data from staged products in addition to published products.
  - getProductSetLimit
```
Integer getProductSetLimit()
```
    Maximum number of products to scan.
  - getIncludeVariants
```
Boolean getIncludeVariants()
```
    If true, searches all product variants. If false, only searches master variants.
  - getCoverageMin
```
Double getCoverageMin()
```
    Minimum attribute coverage of variants to display, applied to both coverage types.
  - getCoverageMax
```
Double getCoverageMax()
```
    Maximum attribute coverage of variants to display, applied to both coverage types.
  - getSortBy
```
String getSortBy()
```
    Default value: coverageAttributeValues - Allowed values: [coverageAttributeValues, coverageAttributeNames] coverageAttributeValues shows the product variants with the most missing attribute values first and coverageAttributeNames the ones with the most missing attribute names.
  - getShowMissingAttributeNames
```
Boolean getShowMissingAttributeNames()
```
    If true, the missingAttributeNames will be included in the results.
  - getProductIds
```
List<String> getProductIds()
```
    Filters results by the provided Product IDs. Cannot be applied in combination with any other filter.
  - getProductTypeIds
```
List<String> getProductTypeIds()
```
    Filters results by the provided product type IDs. Cannot be applied in combination with any other filter.
  - getAttributeName
```
String getAttributeName()
```
    Filters results by the provided attribute name. If provided, products are only checked for this attribute. Therefore, only products of product types which define the attribute name are considered. These product type IDs are then listed in MissingAttributesMeta. The attributeCount and attributeCoverage fields are not part of the response when using this filter. Cannot be applied in combination with any other filter.
  - setLimit
```
void setLimit(Integer limit)
```
  - setOffset
```
void setOffset(Integer offset)
```
  - setStaged
```
void setStaged(Boolean staged)
```
  - setProductSetLimit
```
void setProductSetLimit(Integer productSetLimit)
```
  - setIncludeVariants
```
void setIncludeVariants(Boolean includeVariants)
```
  - setCoverageMin
```
void setCoverageMin(Double coverageMin)
```
  - setCoverageMax
```
void setCoverageMax(Double coverageMax)
```
  - setSortBy
```
void setSortBy(String sortBy)
```
  - setShowMissingAttributeNames
```
void setShowMissingAttributeNames(Boolean showMissingAttributeNames)
```
  - setProductIds
```
void setProductIds(String... productIds)
```
  - setProductIds
```
void setProductIds(List<String> productIds)
```
  - setProductTypeIds
```
void setProductTypeIds(String... productTypeIds)
```
  - setProductTypeIds
```
void setProductTypeIds(List<String> productTypeIds)
```
  - setAttributeName
```
void setAttributeName(String attributeName)
```
  - of
```
static MissingAttributesSearchRequest of()
```
  - of
```
static MissingAttributesSearchRequest of(MissingAttributesSearchRequest template)
```
  - builder
```
static MissingAttributesSearchRequestBuilder builder()
```
  - builder
```
static MissingAttributesSearchRequestBuilder builder(MissingAttributesSearchRequest template)
```
  - withMissingAttributesSearchRequest
```
default <T> T withMissingAttributesSearchRequest(Function<MissingAttributesSearchRequest,T> helper)
```

Interface MissingAttributesSearchRequest

Method Summary

Method Detail

getLimit

getOffset

getStaged

getProductSetLimit

getIncludeVariants

getCoverageMin

getCoverageMax

getSortBy

getShowMissingAttributeNames

getProductIds

getProductTypeIds

getAttributeName

setLimit

setOffset

setStaged

setProductSetLimit

setIncludeVariants

setCoverageMin

setCoverageMax

setSortBy

setShowMissingAttributeNames

setProductIds

setProductIds

setProductTypeIds

setProductTypeIds

setAttributeName

of

of

builder

builder

withMissingAttributesSearchRequest