Package com.commercetools.ml.models.category_recommendations

Interface ProjectCategoryRecommendationMeta

public interface ProjectCategoryRecommendationMeta
ProjectCategoryRecommendationMeta
Example to create an instance using the builder pattern 

     ProjectCategoryRecommendationMeta projectCategoryRecommendationMeta = ProjectCategoryRecommendationMeta.builder()
             .plusGeneralCategoryNames(generalCategoryNamesBuilder -> generalCategoryNamesBuilder)
             .build()

  • Method Details

    • getProductName

      String getProductName()

      The product name that was used to generate recommendations.

      Returns:
      productName

    • getProductImageUrl

      String getProductImageUrl()

      The product image that was used to generate recommendations.

      Returns:
      productImageUrl

    • getGeneralCategoryNames

      @NotNull @NotNull List<String> getGeneralCategoryNames()

      Top 5 general categories that were used internally to generate the project-specific categories. These category names are not related to the categories defined in the project, but they provide additional information to understand the project-specific categories in the results section.

      Returns:
      generalCategoryNames

    • setProductName

      void setProductName(String productName)

      The product name that was used to generate recommendations.

      Parameters:
      productName - value to be set

    • setProductImageUrl

      void setProductImageUrl(String productImageUrl)

      The product image that was used to generate recommendations.

      Parameters:
      productImageUrl - value to be set

    • setGeneralCategoryNames

      void setGeneralCategoryNames(String... generalCategoryNames)

      Top 5 general categories that were used internally to generate the project-specific categories. These category names are not related to the categories defined in the project, but they provide additional information to understand the project-specific categories in the results section.

      Parameters:
      generalCategoryNames - values to be set

    • setGeneralCategoryNames

      void setGeneralCategoryNames(List<String> generalCategoryNames)

      Top 5 general categories that were used internally to generate the project-specific categories. These category names are not related to the categories defined in the project, but they provide additional information to understand the project-specific categories in the results section.

      Parameters:
      generalCategoryNames - values to be set

    • of

      static ProjectCategoryRecommendationMeta of()
      factory method
      Returns:
      instance of ProjectCategoryRecommendationMeta

    • of

      static ProjectCategoryRecommendationMeta of(ProjectCategoryRecommendationMeta template)
      factory method to create a shallow copy ProjectCategoryRecommendationMeta
      Parameters:
      template - instance to be copied
      Returns:
      copy instance

    • deepCopy

      @Nullable static ProjectCategoryRecommendationMeta deepCopy(@Nullable ProjectCategoryRecommendationMeta template)
      factory method to create a deep copy of ProjectCategoryRecommendationMeta
      Parameters:
      template - instance to be copied
      Returns:
      copy instance

    • builder

      static ProjectCategoryRecommendationMetaBuilder builder()
      builder factory method for ProjectCategoryRecommendationMeta
      Returns:
      builder

    • builder

      static ProjectCategoryRecommendationMetaBuilder builder(ProjectCategoryRecommendationMeta template)
      create builder for ProjectCategoryRecommendationMeta instance
      Parameters:
      template - instance with prefilled values for the builder
      Returns:
      builder

    • withProjectCategoryRecommendationMeta

      default <T> T withProjectCategoryRecommendationMeta(Function<ProjectCategoryRecommendationMeta,T> helper)
      accessor map function
      Type Parameters:
      T - mapped type
      Parameters:
      helper - function to map the object
      Returns:
      mapped value

    • typeReference

      static com.fasterxml.jackson.core.type.TypeReference<ProjectCategoryRecommendationMeta> typeReference()
      gives a TypeReference for usage with Jackson DataBind
      Returns:
      TypeReference