Package com.commercetools.ml.models.similar_products

Class SimilarProductBuilder

java.lang.Object

com.commercetools.ml.models.similar_products.SimilarProductBuilder

All Implemented Interfaces:

Builder<SimilarProduct>

public class SimilarProductBuilder
extends Object
implements Builder<SimilarProduct>

SimilarProductBuilder Example to create an instance using the builder pattern

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

Constructor Summary

Constructors

Constructor	Description
SimilarProductBuilder()

Method Summary

Modifier and Type	Method	Description
SimilarProduct	build()	builds SimilarProduct with checking for non-null required values
SimilarProduct	buildUnchecked()	builds SimilarProduct without checking for non-null required values
SimilarProductMeta	getMeta()	Supplementary information about the data used for similarity estimation.
ProductReference	getProduct()	Reference to Product
Long	getVariantId()	ID of the ProductVariant that was compared.
SimilarProductBuilder	meta(SimilarProductMeta meta)	Supplementary information about the data used for similarity estimation.
SimilarProductBuilder	meta(Function<SimilarProductMetaBuilder,SimilarProductMetaBuilder> builder)	Supplementary information about the data used for similarity estimation.
static SimilarProductBuilder	of()	factory method for an instance of SimilarProductBuilder
static SimilarProductBuilder	of(SimilarProduct template)	create builder for SimilarProduct instance
SimilarProductBuilder	product(ProductReference product)	Reference to Product
SimilarProductBuilder	product(Function<ProductReferenceBuilder,ProductReferenceBuilder> builder)	Reference to Product
SimilarProductBuilder	variantId(Long variantId)	ID of the ProductVariant that was compared.
SimilarProductBuilder	withMeta(Function<SimilarProductMetaBuilder,SimilarProductMeta> builder)	Supplementary information about the data used for similarity estimation.
SimilarProductBuilder	withProduct(Function<ProductReferenceBuilder,ProductReference> builder)	Reference to Product

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

SimilarProductBuilder

public SimilarProductBuilder()

Method Details

product

public SimilarProductBuilder product(Function<ProductReferenceBuilder,ProductReferenceBuilder> builder)

Reference to Product

Parameters:

builder - function to build the product value

Returns:

Builder

withProduct

public SimilarProductBuilder withProduct(Function<ProductReferenceBuilder,ProductReference> builder)

Reference to Product

Parameters:

builder - function to build the product value

Returns:

Builder

product

public SimilarProductBuilder product(@Nullable
 ProductReference product)

Reference to Product

Parameters:

product - value to be set

Returns:

Builder

variantId

public SimilarProductBuilder variantId(@Nullable
 Long variantId)

ID of the ProductVariant that was compared.

Parameters:

variantId - value to be set

Returns:

Builder

meta

public SimilarProductBuilder meta(Function<SimilarProductMetaBuilder,SimilarProductMetaBuilder> builder)

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.

Parameters:

builder - function to build the meta value

Returns:

Builder

withMeta

public SimilarProductBuilder withMeta(Function<SimilarProductMetaBuilder,SimilarProductMeta> builder)

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.

Parameters:

builder - function to build the meta value

Returns:

Builder

meta

public SimilarProductBuilder meta(@Nullable
 SimilarProductMeta meta)

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.

Parameters:

meta - value to be set

Returns:

Builder

getProduct

@Nullable
public ProductReference getProduct()

Reference to Product

Returns:

product

getVariantId

@Nullable
public Long getVariantId()

ID of the ProductVariant that was compared.

Returns:

variantId

getMeta

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

Returns:

meta

build

public SimilarProduct build()

builds SimilarProduct with checking for non-null required values

Specified by:

build in interface Builder<SimilarProduct>

Returns:

SimilarProduct

buildUnchecked

public SimilarProduct buildUnchecked()

builds SimilarProduct without checking for non-null required values

Returns:

SimilarProduct

of

public static SimilarProductBuilder of()

factory method for an instance of SimilarProductBuilder

Returns:

builder

of

public static SimilarProductBuilder of(SimilarProduct template)

create builder for SimilarProduct instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder