Package com.commercetools.ml.models.category_recommendations

Class ProjectCategoryRecommendationBuilder

java.lang.Object

com.commercetools.ml.models.category_recommendations.ProjectCategoryRecommendationBuilder

All Implemented Interfaces:

Builder<ProjectCategoryRecommendation>

public class ProjectCategoryRecommendationBuilder
extends Object
implements Builder<ProjectCategoryRecommendation>

ProjectCategoryRecommendationBuilder Example to create an instance using the builder pattern

     ProjectCategoryRecommendation projectCategoryRecommendation = ProjectCategoryRecommendation.builder()
             .category(categoryBuilder -> categoryBuilder)
             .confidence(0.3)
             .path("{path}")
             .build()
 

Constructor Summary

Constructors

Constructor	Description
ProjectCategoryRecommendationBuilder()

Method Summary

Modifier and Type	Method	Description
ProjectCategoryRecommendation	build()	builds ProjectCategoryRecommendation with checking for non-null required values
ProjectCategoryRecommendation	buildUnchecked()	builds ProjectCategoryRecommendation without checking for non-null required values
ProjectCategoryRecommendationBuilder	category(CategoryReference category)	A category that is recommended for a product.
ProjectCategoryRecommendationBuilder	category(Function<CategoryReferenceBuilder,CategoryReferenceBuilder> builder)	A category that is recommended for a product.
ProjectCategoryRecommendationBuilder	confidence(Double confidence)	Probability score for the category recommendation.
CategoryReference	getCategory()	A category that is recommended for a product.
Double	getConfidence()	Probability score for the category recommendation.
String	getPath()	Breadcrumb path to the recommended category.
static ProjectCategoryRecommendationBuilder	of()	factory method for an instance of ProjectCategoryRecommendationBuilder
static ProjectCategoryRecommendationBuilder	of(ProjectCategoryRecommendation template)	create builder for ProjectCategoryRecommendation instance
ProjectCategoryRecommendationBuilder	path(String path)	Breadcrumb path to the recommended category.
ProjectCategoryRecommendationBuilder	withCategory(Function<CategoryReferenceBuilder,CategoryReference> builder)	A category that is recommended for a product.

Methods inherited from class java.lang.Object

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

Constructor Details

ProjectCategoryRecommendationBuilder

public ProjectCategoryRecommendationBuilder()

Method Details

category

public ProjectCategoryRecommendationBuilder category(Function<CategoryReferenceBuilder,CategoryReferenceBuilder> builder)

A category that is recommended for a product.

Parameters:

builder - function to build the category value

Returns:

Builder

withCategory

public ProjectCategoryRecommendationBuilder withCategory(Function<CategoryReferenceBuilder,CategoryReference> builder)

A category that is recommended for a product.

Parameters:

builder - function to build the category value

Returns:

Builder

category

public ProjectCategoryRecommendationBuilder category(CategoryReference category)

A category that is recommended for a product.

Parameters:

category - value to be set

Returns:

Builder

confidence

public ProjectCategoryRecommendationBuilder confidence(Double confidence)

Probability score for the category recommendation.

Parameters:

confidence - value to be set

Returns:

Builder

path

public ProjectCategoryRecommendationBuilder path(String path)

Breadcrumb path to the recommended category. This only picks up one language, not all available languages for the category. English is prioritized, but if English data is not available, an arbitrary language is selected. Do not use this to identify a category,use the category ID from the category reference instead.

Parameters:

path - value to be set

Returns:

Builder

getCategory

public CategoryReference getCategory()

A category that is recommended for a product.

Returns:

category

getConfidence

public Double getConfidence()

Probability score for the category recommendation.

Returns:

confidence

getPath

public String getPath()

Breadcrumb path to the recommended category. This only picks up one language, not all available languages for the category. English is prioritized, but if English data is not available, an arbitrary language is selected. Do not use this to identify a category,use the category ID from the category reference instead.

Returns:

path

build

public ProjectCategoryRecommendation build()

builds ProjectCategoryRecommendation with checking for non-null required values

Specified by:

build in interface Builder<ProjectCategoryRecommendation>

Returns:

ProjectCategoryRecommendation

buildUnchecked

public ProjectCategoryRecommendation buildUnchecked()

builds ProjectCategoryRecommendation without checking for non-null required values

Returns:

ProjectCategoryRecommendation

of

public static ProjectCategoryRecommendationBuilder of()

factory method for an instance of ProjectCategoryRecommendationBuilder

Returns:

builder

of

public static ProjectCategoryRecommendationBuilder of(ProjectCategoryRecommendation template)

create builder for ProjectCategoryRecommendation instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder