com.commercetools.ml.models.missing_data

Class MissingAttributesSearchRequestImpl

java.lang.Object

com.commercetools.ml.models.missing_data.MissingAttributesSearchRequestImpl

All Implemented Interfaces:

MissingAttributesSearchRequest

public final class MissingAttributesSearchRequestImpl
extends Object
implements MissingAttributesSearchRequest

Constructor Summary

Constructors

Constructor and Description
MissingAttributesSearchRequestImpl()

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
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.
int	hashCode()
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)

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.commercetools.ml.models.missing_data.MissingAttributesSearchRequest

builder, builder, of, of, withMissingAttributesSearchRequest

Constructor Detail

MissingAttributesSearchRequestImpl

public MissingAttributesSearchRequestImpl()

Method Detail

getLimit

public Integer getLimit()

Specified by:

getLimit in interface MissingAttributesSearchRequest

getOffset

public Integer getOffset()

Specified by:

getOffset in interface MissingAttributesSearchRequest

getStaged

public Boolean getStaged()

If true, searches data from staged products in addition to published products.

Specified by:

getStaged in interface MissingAttributesSearchRequest

getProductSetLimit

public Integer getProductSetLimit()

Maximum number of products to scan.

Specified by:

getProductSetLimit in interface MissingAttributesSearchRequest

getIncludeVariants

public Boolean getIncludeVariants()

If true, searches all product variants. If false, only searches master variants.

Specified by:

getIncludeVariants in interface MissingAttributesSearchRequest

getCoverageMin

public Double getCoverageMin()

Minimum attribute coverage of variants to display, applied to both coverage types.

Specified by:

getCoverageMin in interface MissingAttributesSearchRequest

getCoverageMax

public Double getCoverageMax()

Maximum attribute coverage of variants to display, applied to both coverage types.

Specified by:

getCoverageMax in interface MissingAttributesSearchRequest

getSortBy

public 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.

Specified by:

getSortBy in interface MissingAttributesSearchRequest

getShowMissingAttributeNames

public Boolean getShowMissingAttributeNames()

If true, the missingAttributeNames will be included in the results.

Specified by:

getShowMissingAttributeNames in interface MissingAttributesSearchRequest

getProductIds

public List<String> getProductIds()

Filters results by the provided Product IDs. Cannot be applied in combination with any other filter.

Specified by:

getProductIds in interface MissingAttributesSearchRequest

getProductTypeIds

public List<String> getProductTypeIds()

Filters results by the provided product type IDs. Cannot be applied in combination with any other filter.

Specified by:

getProductTypeIds in interface MissingAttributesSearchRequest

getAttributeName

public 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.

Specified by:

getAttributeName in interface MissingAttributesSearchRequest

setLimit

public void setLimit(Integer limit)

Specified by:

setLimit in interface MissingAttributesSearchRequest

setOffset

public void setOffset(Integer offset)

Specified by:

setOffset in interface MissingAttributesSearchRequest

setStaged

public void setStaged(Boolean staged)

Specified by:

setStaged in interface MissingAttributesSearchRequest

setProductSetLimit

public void setProductSetLimit(Integer productSetLimit)

Specified by:

setProductSetLimit in interface MissingAttributesSearchRequest

setIncludeVariants

public void setIncludeVariants(Boolean includeVariants)

Specified by:

setIncludeVariants in interface MissingAttributesSearchRequest

setCoverageMin

public void setCoverageMin(Double coverageMin)

Specified by:

setCoverageMin in interface MissingAttributesSearchRequest

setCoverageMax

public void setCoverageMax(Double coverageMax)

Specified by:

setCoverageMax in interface MissingAttributesSearchRequest

setSortBy

public void setSortBy(String sortBy)

Specified by:

setSortBy in interface MissingAttributesSearchRequest

setShowMissingAttributeNames

public void setShowMissingAttributeNames(Boolean showMissingAttributeNames)

Specified by:

setShowMissingAttributeNames in interface MissingAttributesSearchRequest

setProductIds

public void setProductIds(String... productIds)

Specified by:

setProductIds in interface MissingAttributesSearchRequest

setProductIds

public void setProductIds(List<String> productIds)

Specified by:

setProductIds in interface MissingAttributesSearchRequest

setProductTypeIds

public void setProductTypeIds(String... productTypeIds)

Specified by:

setProductTypeIds in interface MissingAttributesSearchRequest

setProductTypeIds

public void setProductTypeIds(List<String> productTypeIds)

Specified by:

setProductTypeIds in interface MissingAttributesSearchRequest

setAttributeName

public void setAttributeName(String attributeName)

Specified by:

setAttributeName in interface MissingAttributesSearchRequest

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object