com.commercetools.ml.models.similar_products

Interface SimilarProduct

All Known Implementing Classes:

SimilarProductImpl

public interface SimilarProduct

One part of a SimilarProductPair. Refers to a specific ProductVariant.

Example to create an instance using the builder pattern

     SimilarProduct similarProduct = SimilarProduct.builder()
             .build()
 

Method Summary

Modifier and Type	Method and Description
static SimilarProductBuilder	builder()
static SimilarProductBuilder	builder(SimilarProduct template)
@Valid SimilarProductMeta	getMeta() Supplementary information about the data used for similarity estimation.
@Valid ProductReference	getProduct() Reference to Product
Long	getVariantId() ID of the ProductVariant that was compared.
static SimilarProduct	of()
static SimilarProduct	of(SimilarProduct template)
void	setMeta(SimilarProductMeta meta)
void	setProduct(ProductReference product)
void	setVariantId(Long variantId)
static com.fasterxml.jackson.core.type.TypeReference<SimilarProduct>	typeReference()
default <T> T	withSimilarProduct(Function<SimilarProduct,T> helper)

Method Detail

getProduct

@Valid
@Valid ProductReference getProduct()

Reference to Product

getVariantId

Long getVariantId()

ID of the ProductVariant that was compared.

getMeta

@Valid
@Valid SimilarProductMeta getMeta()

Supplementary information about the data used for similarity estimation. This information helps you understand the estimated confidence score, but it should not be used to identify a product.

setProduct

void setProduct(ProductReference product)

setVariantId

void setVariantId(Long variantId)

setMeta

void setMeta(SimilarProductMeta meta)

of

static SimilarProduct of()

of

static SimilarProduct of(SimilarProduct template)

builder

static SimilarProductBuilder builder()

builder

static SimilarProductBuilder builder(SimilarProduct template)

withSimilarProduct

default <T> T withSimilarProduct(Function<SimilarProduct,T> helper)

typeReference

static com.fasterxml.jackson.core.type.TypeReference<SimilarProduct> typeReference()