001
002package com.commercetools.ml.models.general_category_recommendations;
003
004import java.time.*;
005import java.util.*;
006import java.util.function.Function;
007
008import javax.annotation.Nullable;
009import javax.validation.constraints.NotNull;
010
011import com.fasterxml.jackson.annotation.*;
012import com.fasterxml.jackson.databind.annotation.*;
013
014import io.vrap.rmf.base.client.utils.Generated;
015
016/**
017 * GeneralCategoryRecommendation
018 *
019 * <hr>
020 * Example to create an instance using the builder pattern
021 * <div class=code-example>
022 * <pre><code class='java'>
023 *     GeneralCategoryRecommendation generalCategoryRecommendation = GeneralCategoryRecommendation.builder()
024 *             .categoryName("{categoryName}")
025 *             .confidence(0.3)
026 *             .build()
027 * </code></pre>
028 * </div>
029 */
030@Generated(value = "io.vrap.rmf.codegen.rendering.CoreCodeGenerator", comments = "https://github.com/commercetools/rmf-codegen")
031@JsonDeserialize(as = GeneralCategoryRecommendationImpl.class)
032public interface GeneralCategoryRecommendation {
033
034    /**
035     *  <p>An English category name that is recommended for a product.</p>
036     * @return categoryName
037     */
038    @NotNull
039    @JsonProperty("categoryName")
040    public String getCategoryName();
041
042    /**
043     *  <p>Probability score for the category recommendation.</p>
044     * @return confidence
045     */
046    @NotNull
047    @JsonProperty("confidence")
048    public Double getConfidence();
049
050    /**
051     *  <p>An English category name that is recommended for a product.</p>
052     * @param categoryName value to be set
053     */
054
055    public void setCategoryName(final String categoryName);
056
057    /**
058     *  <p>Probability score for the category recommendation.</p>
059     * @param confidence value to be set
060     */
061
062    public void setConfidence(final Double confidence);
063
064    /**
065     * factory method
066     * @return instance of GeneralCategoryRecommendation
067     */
068    public static GeneralCategoryRecommendation of() {
069        return new GeneralCategoryRecommendationImpl();
070    }
071
072    /**
073     * factory method to create a shallow copy GeneralCategoryRecommendation
074     * @param template instance to be copied
075     * @return copy instance
076     */
077    public static GeneralCategoryRecommendation of(final GeneralCategoryRecommendation template) {
078        GeneralCategoryRecommendationImpl instance = new GeneralCategoryRecommendationImpl();
079        instance.setCategoryName(template.getCategoryName());
080        instance.setConfidence(template.getConfidence());
081        return instance;
082    }
083
084    /**
085     * factory method to create a deep copy of GeneralCategoryRecommendation
086     * @param template instance to be copied
087     * @return copy instance
088     */
089    @Nullable
090    public static GeneralCategoryRecommendation deepCopy(@Nullable final GeneralCategoryRecommendation template) {
091        if (template == null) {
092            return null;
093        }
094        GeneralCategoryRecommendationImpl instance = new GeneralCategoryRecommendationImpl();
095        instance.setCategoryName(template.getCategoryName());
096        instance.setConfidence(template.getConfidence());
097        return instance;
098    }
099
100    /**
101     * builder factory method for GeneralCategoryRecommendation
102     * @return builder
103     */
104    public static GeneralCategoryRecommendationBuilder builder() {
105        return GeneralCategoryRecommendationBuilder.of();
106    }
107
108    /**
109     * create builder for GeneralCategoryRecommendation instance
110     * @param template instance with prefilled values for the builder
111     * @return builder
112     */
113    public static GeneralCategoryRecommendationBuilder builder(final GeneralCategoryRecommendation template) {
114        return GeneralCategoryRecommendationBuilder.of(template);
115    }
116
117    /**
118     * accessor map function
119     * @param <T> mapped type
120     * @param helper function to map the object
121     * @return mapped value
122     */
123    default <T> T withGeneralCategoryRecommendation(Function<GeneralCategoryRecommendation, T> helper) {
124        return helper.apply(this);
125    }
126
127    /**
128     * gives a TypeReference for usage with Jackson DataBind
129     * @return TypeReference
130     */
131    public static com.fasterxml.jackson.core.type.TypeReference<GeneralCategoryRecommendation> typeReference() {
132        return new com.fasterxml.jackson.core.type.TypeReference<GeneralCategoryRecommendation>() {
133            @Override
134            public String toString() {
135                return "TypeReference<GeneralCategoryRecommendation>";
136            }
137        };
138    }
139}