Package com.commercetools.ml.models.similar_products

Class SimilarProductSearchRequestBuilder

java.lang.Object

com.commercetools.ml.models.similar_products.SimilarProductSearchRequestBuilder

All Implemented Interfaces:

Builder<SimilarProductSearchRequest>

public class SimilarProductSearchRequestBuilder
extends Object
implements Builder<SimilarProductSearchRequest>

SimilarProductSearchRequestBuilder Example to create an instance using the builder pattern

     SimilarProductSearchRequest similarProductSearchRequest = SimilarProductSearchRequest.builder()
             .build()
 

Constructor Summary

Constructors

Constructor	Description
SimilarProductSearchRequestBuilder()

Method Summary

Modifier and Type	Method	Description
SimilarProductSearchRequestBuilder	addProductSetSelectors(Function<ProductSetSelectorBuilder,ProductSetSelector> builder)	Array of length 2 of ProductSetSelector
SimilarProductSearchRequest	build()	builds SimilarProductSearchRequest with checking for non-null required values
SimilarProductSearchRequest	buildUnchecked()	builds SimilarProductSearchRequest without checking for non-null required values
SimilarProductSearchRequestBuilder	confidenceMax(Double confidenceMax)	set the value to the confidenceMax
SimilarProductSearchRequestBuilder	confidenceMin(Double confidenceMin)	set the value to the confidenceMin
SimilarProductSearchRequestBuilder	currencyCode(String currencyCode)	The three-digit currency code to compare prices in.
Double	getConfidenceMax()	value of confidenceMax}
Double	getConfidenceMin()	value of confidenceMin}
String	getCurrencyCode()	The three-digit currency code to compare prices in.
String	getLanguage()	language tag used to prioritize language for text comparisons.
Long	getLimit()	Number of results requested.
Long	getOffset()	Number of elements skipped.
List<ProductSetSelector>	getProductSetSelectors()	Array of length 2 of ProductSetSelector
SimilarityMeasures	getSimilarityMeasures()	similarityMeasures defines the attributes taken into account to measure product similarity.
SimilarProductSearchRequestBuilder	language(String language)	language tag used to prioritize language for text comparisons.
SimilarProductSearchRequestBuilder	limit(Long limit)	Number of results requested.
static SimilarProductSearchRequestBuilder	of()	factory method for an instance of SimilarProductSearchRequestBuilder
static SimilarProductSearchRequestBuilder	of(SimilarProductSearchRequest template)	create builder for SimilarProductSearchRequest instance
SimilarProductSearchRequestBuilder	offset(Long offset)	Number of elements skipped.
SimilarProductSearchRequestBuilder	plusProductSetSelectors(ProductSetSelector... productSetSelectors)	Array of length 2 of ProductSetSelector
SimilarProductSearchRequestBuilder	plusProductSetSelectors(Function<ProductSetSelectorBuilder,ProductSetSelectorBuilder> builder)	Array of length 2 of ProductSetSelector
SimilarProductSearchRequestBuilder	productSetSelectors(ProductSetSelector... productSetSelectors)	Array of length 2 of ProductSetSelector
SimilarProductSearchRequestBuilder	productSetSelectors(List<ProductSetSelector> productSetSelectors)	Array of length 2 of ProductSetSelector
SimilarProductSearchRequestBuilder	setProductSetSelectors(Function<ProductSetSelectorBuilder,ProductSetSelector> builder)	Array of length 2 of ProductSetSelector
SimilarProductSearchRequestBuilder	similarityMeasures(SimilarityMeasures similarityMeasures)	similarityMeasures defines the attributes taken into account to measure product similarity.
SimilarProductSearchRequestBuilder	similarityMeasures(Function<SimilarityMeasuresBuilder,SimilarityMeasuresBuilder> builder)	similarityMeasures defines the attributes taken into account to measure product similarity.
SimilarProductSearchRequestBuilder	withProductSetSelectors(Function<ProductSetSelectorBuilder,ProductSetSelectorBuilder> builder)	Array of length 2 of ProductSetSelector
SimilarProductSearchRequestBuilder	withSimilarityMeasures(Function<SimilarityMeasuresBuilder,SimilarityMeasures> builder)	similarityMeasures defines the attributes taken into account to measure product similarity.

Methods inherited from class java.lang.Object

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

Constructor Details

SimilarProductSearchRequestBuilder

public SimilarProductSearchRequestBuilder()

Method Details

limit

public SimilarProductSearchRequestBuilder limit(@Nullable
 Long limit)

Number of results requested.

Parameters:

limit - value to be set

Returns:

Builder

offset

public SimilarProductSearchRequestBuilder offset(@Nullable
 Long offset)

Number of elements skipped.

Parameters:

offset - value to be set

Returns:

Builder

language

public SimilarProductSearchRequestBuilder language(@Nullable
 String language)

language tag used to prioritize language for text comparisons.

Parameters:

language - value to be set

Returns:

Builder

currencyCode

public SimilarProductSearchRequestBuilder currencyCode(@Nullable
 String currencyCode)

The three-digit currency code to compare prices in. When a product has multiple prices, all prices for the product are converted to the currency provided by the currency attribute and the median price is calculated for comparison. Currencies are converted using the ECB currency exchange rates at the time the request is made. Of the currency codes, only currencies with currency exchange rates provided by the ECB are supported.

Parameters:

currencyCode - value to be set

Returns:

Builder

similarityMeasures

public SimilarProductSearchRequestBuilder similarityMeasures(Function<SimilarityMeasuresBuilder,SimilarityMeasuresBuilder> builder)

similarityMeasures defines the attributes taken into account to measure product similarity.

Parameters:

builder - function to build the similarityMeasures value

Returns:

Builder

withSimilarityMeasures

public SimilarProductSearchRequestBuilder withSimilarityMeasures(Function<SimilarityMeasuresBuilder,SimilarityMeasures> builder)

similarityMeasures defines the attributes taken into account to measure product similarity.

Parameters:

builder - function to build the similarityMeasures value

Returns:

Builder

similarityMeasures

public SimilarProductSearchRequestBuilder similarityMeasures(@Nullable
 SimilarityMeasures similarityMeasures)

similarityMeasures defines the attributes taken into account to measure product similarity.

Parameters:

similarityMeasures - value to be set

Returns:

Builder

productSetSelectors

public SimilarProductSearchRequestBuilder productSetSelectors(@Nullable
 ProductSetSelector... productSetSelectors)

Array of length 2 of ProductSetSelector

Parameters:

productSetSelectors - value to be set

Returns:

Builder

productSetSelectors

public SimilarProductSearchRequestBuilder productSetSelectors(@Nullable
 List<ProductSetSelector> productSetSelectors)

Array of length 2 of ProductSetSelector

Parameters:

productSetSelectors - value to be set

Returns:

Builder

plusProductSetSelectors

public SimilarProductSearchRequestBuilder plusProductSetSelectors(@Nullable
 ProductSetSelector... productSetSelectors)

Array of length 2 of ProductSetSelector

Parameters:

productSetSelectors - value to be set

Returns:

Builder

plusProductSetSelectors

public SimilarProductSearchRequestBuilder plusProductSetSelectors(Function<ProductSetSelectorBuilder,ProductSetSelectorBuilder> builder)

Array of length 2 of ProductSetSelector

Parameters:

builder - function to build the productSetSelectors value

Returns:

Builder

withProductSetSelectors

public SimilarProductSearchRequestBuilder withProductSetSelectors(Function<ProductSetSelectorBuilder,ProductSetSelectorBuilder> builder)

Array of length 2 of ProductSetSelector

Parameters:

builder - function to build the productSetSelectors value

Returns:

Builder

addProductSetSelectors

public SimilarProductSearchRequestBuilder addProductSetSelectors(Function<ProductSetSelectorBuilder,ProductSetSelector> builder)

Array of length 2 of ProductSetSelector

Parameters:

builder - function to build the productSetSelectors value

Returns:

Builder

setProductSetSelectors

public SimilarProductSearchRequestBuilder setProductSetSelectors(Function<ProductSetSelectorBuilder,ProductSetSelector> builder)

Array of length 2 of ProductSetSelector

Parameters:

builder - function to build the productSetSelectors value

Returns:

Builder

confidenceMin

public SimilarProductSearchRequestBuilder confidenceMin(@Nullable
 Double confidenceMin)

set the value to the confidenceMin

Parameters:

confidenceMin - value to be set

Returns:

Builder

confidenceMax

public SimilarProductSearchRequestBuilder confidenceMax(@Nullable
 Double confidenceMax)

set the value to the confidenceMax

Parameters:

confidenceMax - value to be set

Returns:

Builder

getLimit

@Nullable
public Long getLimit()

Number of results requested.

Returns:

limit

getOffset

@Nullable
public Long getOffset()

Number of elements skipped.

Returns:

offset

getLanguage

@Nullable
public String getLanguage()

language tag used to prioritize language for text comparisons.

Returns:

language

getCurrencyCode

@Nullable
public String getCurrencyCode()

The three-digit currency code to compare prices in. When a product has multiple prices, all prices for the product are converted to the currency provided by the currency attribute and the median price is calculated for comparison. Currencies are converted using the ECB currency exchange rates at the time the request is made. Of the currency codes, only currencies with currency exchange rates provided by the ECB are supported.

Returns:

currencyCode

getSimilarityMeasures

@Nullable
public SimilarityMeasures getSimilarityMeasures()

similarityMeasures defines the attributes taken into account to measure product similarity.

Returns:

similarityMeasures

getProductSetSelectors

@Nullable
public List<ProductSetSelector> getProductSetSelectors()

Array of length 2 of ProductSetSelector

Returns:

productSetSelectors

getConfidenceMin

@Nullable
public Double getConfidenceMin()

value of confidenceMin}

Returns:

confidenceMin

getConfidenceMax

@Nullable
public Double getConfidenceMax()

value of confidenceMax}

Returns:

confidenceMax

build

public SimilarProductSearchRequest build()

builds SimilarProductSearchRequest with checking for non-null required values

Specified by:

build in interface Builder<SimilarProductSearchRequest>

Returns:

SimilarProductSearchRequest

buildUnchecked

public SimilarProductSearchRequest buildUnchecked()

builds SimilarProductSearchRequest without checking for non-null required values

Returns:

SimilarProductSearchRequest

of

public static SimilarProductSearchRequestBuilder of()

factory method for an instance of SimilarProductSearchRequestBuilder

Returns:

builder

of

public static SimilarProductSearchRequestBuilder of(SimilarProductSearchRequest template)

create builder for SimilarProductSearchRequest instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder