Package com.commercetools.api.models.product_search

Interface ProductSearchFacetDistinctValue

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

     ProductSearchFacetDistinctValue productSearchFacetDistinctValue = ProductSearchFacetDistinctValue.builder()
             .name("{name}")
             .field("{field}")
             .build()

  • Method Details

    • getName

      @NotNull @NotNull String getName()

      Name of the distinct facet to appear in the ProductSearchFacetResultBucket.

      Returns:
      name

    • getScope

      ProductSearchFacetScopeEnum getScope()

      Whether the facet must consider only the Products resulting from the search (query) or all the Products (all).

      Returns:
      scope

    • getFilter

      @Valid @Valid SearchQuery getFilter()

      Additional filtering expression to apply to the facet result before calculating the facet.

      Returns:
      filter

    • getLevel

      ProductSearchFacetCountLevelEnum getLevel()

      Specify whether to count Products (products) or Product Variants (variants).

      Returns:
      level

    • getField

      @NotNull @NotNull String getField()

      The searchable Product field to facet on.

      Returns:
      field

    • getIncludes

      List<String> getIncludes()

      Specify which bucket keys the facets results should include.

      Returns:
      includes

    • getSort

      @Valid @Valid ProductSearchFacetDistinctBucketSortExpression getSort()

      Define how the buckets are sorted.

      Returns:
      sort

    • getLimit

      Integer getLimit()

      Maximum number of buckets to return.

      Returns:
      limit

    • getLanguage

      String getLanguage()

      String value specifying linguistic and regional preferences using the IETF language tag format, as described in BCP 47. The format combines language, script, and region using hyphen-separated subtags. For example: en, en-US, zh-Hans-SG.

      Returns:
      language

    • getFieldType

      SearchFieldType getFieldType()

      If the field is not standard, this must be the Attribute type.

      Returns:
      fieldType

    • getMissing

      String getMissing()

      Default value to use if the specified field is not present on some Products.

      Returns:
      missing

    • setName

      void setName(String name)

      Name of the distinct facet to appear in the ProductSearchFacetResultBucket.

      Parameters:
      name - value to be set

    • setScope

      void setScope(ProductSearchFacetScopeEnum scope)

      Whether the facet must consider only the Products resulting from the search (query) or all the Products (all).

      Parameters:
      scope - value to be set

    • setFilter

      void setFilter(SearchQuery filter)

      Additional filtering expression to apply to the facet result before calculating the facet.

      Parameters:
      filter - value to be set

    • setLevel

      void setLevel(ProductSearchFacetCountLevelEnum level)

      Specify whether to count Products (products) or Product Variants (variants).

      Parameters:
      level - value to be set

    • setField

      void setField(String field)

      The searchable Product field to facet on.

      Parameters:
      field - value to be set

    • setIncludes

      void setIncludes(String... includes)

      Specify which bucket keys the facets results should include.

      Parameters:
      includes - values to be set

    • setIncludes

      void setIncludes(List<String> includes)

      Specify which bucket keys the facets results should include.

      Parameters:
      includes - values to be set

    • setSort

      void setSort(ProductSearchFacetDistinctBucketSortExpression sort)

      Define how the buckets are sorted.

      Parameters:
      sort - value to be set

    • setLimit

      void setLimit(Integer limit)

      Maximum number of buckets to return.

      Parameters:
      limit - value to be set

    • setLanguage

      void setLanguage(String language)

      String value specifying linguistic and regional preferences using the IETF language tag format, as described in BCP 47. The format combines language, script, and region using hyphen-separated subtags. For example: en, en-US, zh-Hans-SG.

      Parameters:
      language - value to be set

    • setFieldType

      void setFieldType(SearchFieldType fieldType)

      If the field is not standard, this must be the Attribute type.

      Parameters:
      fieldType - value to be set

    • setMissing

      void setMissing(String missing)

      Default value to use if the specified field is not present on some Products.

      Parameters:
      missing - value to be set

    • of

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

    • of

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

    • copyDeep

      ProductSearchFacetDistinctValue copyDeep()

    • deepCopy

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

    • builder

      static ProductSearchFacetDistinctValueBuilder builder()
      builder factory method for ProductSearchFacetDistinctValue
      Returns:
      builder

    • builder

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

    • withProductSearchFacetDistinctValue

      default <T> T withProductSearchFacetDistinctValue(Function<ProductSearchFacetDistinctValue,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<ProductSearchFacetDistinctValue> typeReference()
      gives a TypeReference for usage with Jackson DataBind
      Returns:
      TypeReference