Package com.commercetools.api.models.product_search

Class ProductSearchFacetDistinctValueBuilder

java.lang.Object

com.commercetools.api.models.product_search.ProductSearchFacetDistinctValueBuilder

All Implemented Interfaces:

Builder<ProductSearchFacetDistinctValue>

public class ProductSearchFacetDistinctValueBuilder
extends Object
implements Builder<ProductSearchFacetDistinctValue>

ProductSearchFacetDistinctValueBuilder Example to create an instance using the builder pattern

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

Constructor Summary

Constructors

Constructor	Description
ProductSearchFacetDistinctValueBuilder()

Method Summary

Modifier and Type	Method	Description
ProductSearchFacetDistinctValue	build()	builds ProductSearchFacetDistinctValue with checking for non-null required values
ProductSearchFacetDistinctValue	buildUnchecked()	builds ProductSearchFacetDistinctValue without checking for non-null required values
ProductSearchFacetDistinctValueBuilder	field(String field)	The searchable Product field to facet on.
ProductSearchFacetDistinctValueBuilder	fieldType(SearchFieldType fieldType)	If the field is not standard, this must be the Attribute type.
ProductSearchFacetDistinctValueBuilder	filter(SearchQuery filter)	Additional filtering expression to apply to the search result before calculating the facet.
ProductSearchFacetDistinctValueBuilder	filter(Function<SearchQueryBuilder,SearchQueryBuilder> builder)	Additional filtering expression to apply to the search result before calculating the facet.
String	getField()	The searchable Product field to facet on.
SearchFieldType	getFieldType()	If the field is not standard, this must be the Attribute type.
SearchQuery	getFilter()	Additional filtering expression to apply to the search result before calculating the facet.
List<String>	getIncludes()	Specify which bucket keys the facets results should include.
String	getLanguage()	String value specifying linguistic and regional preferences using the IETF language tag format, as described in BCP 47.
ProductSearchFacetCountLevelEnum	getLevel()	Specify whether to count Products (products) or Product Variants (variants).
Integer	getLimit()	Maximum number of buckets to return.
String	getMissing()	Default value to use if the specified field is not present on some Products.
String	getName()	Name of the distinct facet to appear in the ProductSearchFacetResultBucket.
ProductSearchFacetScopeEnum	getScope()	Whether the facet must consider only the Products resulting from the search (query) or all the Products (all).
ProductSearchFacetDistinctBucketSortExpression	getSort()	Define how the buckets are sorted.
ProductSearchFacetDistinctValueBuilder	includes(String... includes)	Specify which bucket keys the facets results should include.
ProductSearchFacetDistinctValueBuilder	includes(List<String> includes)	Specify which bucket keys the facets results should include.
ProductSearchFacetDistinctValueBuilder	language(String language)	String value specifying linguistic and regional preferences using the IETF language tag format, as described in BCP 47.
ProductSearchFacetDistinctValueBuilder	level(ProductSearchFacetCountLevelEnum level)	Specify whether to count Products (products) or Product Variants (variants).
ProductSearchFacetDistinctValueBuilder	limit(Integer limit)	Maximum number of buckets to return.
ProductSearchFacetDistinctValueBuilder	missing(String missing)	Default value to use if the specified field is not present on some Products.
ProductSearchFacetDistinctValueBuilder	name(String name)	Name of the distinct facet to appear in the ProductSearchFacetResultBucket.
static ProductSearchFacetDistinctValueBuilder	of()	factory method for an instance of ProductSearchFacetDistinctValueBuilder
static ProductSearchFacetDistinctValueBuilder	of(ProductSearchFacetDistinctValue template)	create builder for ProductSearchFacetDistinctValue instance
ProductSearchFacetDistinctValueBuilder	plusIncludes(String... includes)	Specify which bucket keys the facets results should include.
ProductSearchFacetDistinctValueBuilder	scope(ProductSearchFacetScopeEnum scope)	Whether the facet must consider only the Products resulting from the search (query) or all the Products (all).
ProductSearchFacetDistinctValueBuilder	sort(ProductSearchFacetDistinctBucketSortExpression sort)	Define how the buckets are sorted.
ProductSearchFacetDistinctValueBuilder	sort(Function<ProductSearchFacetDistinctBucketSortExpressionBuilder,ProductSearchFacetDistinctBucketSortExpressionBuilder> builder)	Define how the buckets are sorted.
ProductSearchFacetDistinctValueBuilder	withFilter(Function<SearchQueryBuilder,SearchQuery> builder)	Additional filtering expression to apply to the search result before calculating the facet.
ProductSearchFacetDistinctValueBuilder	withSort(Function<ProductSearchFacetDistinctBucketSortExpressionBuilder,ProductSearchFacetDistinctBucketSortExpression> builder)	Define how the buckets are sorted.

Methods inherited from class java.lang.Object

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

Constructor Details

ProductSearchFacetDistinctValueBuilder

public ProductSearchFacetDistinctValueBuilder()

Method Details

name

public ProductSearchFacetDistinctValueBuilder name(String name)

Name of the distinct facet to appear in the ProductSearchFacetResultBucket.

Parameters:

name - value to be set

Returns:

Builder

scope

public ProductSearchFacetDistinctValueBuilder scope(@Nullable
 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

Returns:

Builder

filter

public ProductSearchFacetDistinctValueBuilder filter(Function<SearchQueryBuilder,SearchQueryBuilder> builder)

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

Parameters:

builder - function to build the filter value

Returns:

Builder

withFilter

public ProductSearchFacetDistinctValueBuilder withFilter(Function<SearchQueryBuilder,SearchQuery> builder)

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

Parameters:

builder - function to build the filter value

Returns:

Builder

filter

public ProductSearchFacetDistinctValueBuilder filter(@Nullable
 SearchQuery filter)

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

Parameters:

filter - value to be set

Returns:

Builder

level

public ProductSearchFacetDistinctValueBuilder level(@Nullable
 ProductSearchFacetCountLevelEnum level)

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

Parameters:

level - value to be set

Returns:

Builder

field

public ProductSearchFacetDistinctValueBuilder field(String field)

The searchable Product field to facet on.

Parameters:

field - value to be set

Returns:

Builder

includes

public ProductSearchFacetDistinctValueBuilder includes(@Nullable
 String... includes)

Specify which bucket keys the facets results should include.

Parameters:

includes - value to be set

Returns:

Builder

includes

public ProductSearchFacetDistinctValueBuilder includes(@Nullable
 List<String> includes)

Specify which bucket keys the facets results should include.

Parameters:

includes - value to be set

Returns:

Builder

plusIncludes

public ProductSearchFacetDistinctValueBuilder plusIncludes(@Nullable
 String... includes)

Specify which bucket keys the facets results should include.

Parameters:

includes - value to be set

Returns:

Builder

sort

public ProductSearchFacetDistinctValueBuilder sort(Function<ProductSearchFacetDistinctBucketSortExpressionBuilder,ProductSearchFacetDistinctBucketSortExpressionBuilder> builder)

Define how the buckets are sorted.

Parameters:

builder - function to build the sort value

Returns:

Builder

withSort

public ProductSearchFacetDistinctValueBuilder withSort(Function<ProductSearchFacetDistinctBucketSortExpressionBuilder,ProductSearchFacetDistinctBucketSortExpression> builder)

Define how the buckets are sorted.

Parameters:

builder - function to build the sort value

Returns:

Builder

sort

public ProductSearchFacetDistinctValueBuilder sort(@Nullable
 ProductSearchFacetDistinctBucketSortExpression sort)

Define how the buckets are sorted.

Parameters:

sort - value to be set

Returns:

Builder

limit

public ProductSearchFacetDistinctValueBuilder limit(@Nullable
 Integer limit)

Maximum number of buckets to return.

Parameters:

limit - value to be set

Returns:

Builder

language

public ProductSearchFacetDistinctValueBuilder language(@Nullable
 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

Returns:

Builder

fieldType

public ProductSearchFacetDistinctValueBuilder fieldType(@Nullable
 SearchFieldType fieldType)

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

Parameters:

fieldType - value to be set

Returns:

Builder

missing

public ProductSearchFacetDistinctValueBuilder missing(@Nullable
 String missing)

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

Parameters:

missing - value to be set

Returns:

Builder

getName

public String getName()

Name of the distinct facet to appear in the ProductSearchFacetResultBucket.

Returns:

name

getScope

@Nullable
public ProductSearchFacetScopeEnum getScope()

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

Returns:

scope

getFilter

@Nullable
public SearchQuery getFilter()

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

Returns:

filter

getLevel

@Nullable
public ProductSearchFacetCountLevelEnum getLevel()

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

Returns:

level

getField

public String getField()

The searchable Product field to facet on.

Returns:

field

getIncludes

@Nullable
public List<String> getIncludes()

Specify which bucket keys the facets results should include.

Returns:

includes

getSort

@Nullable
public ProductSearchFacetDistinctBucketSortExpression getSort()

Define how the buckets are sorted.

Returns:

sort

getLimit

@Nullable
public Integer getLimit()

Maximum number of buckets to return.

Returns:

limit

getLanguage

@Nullable
public 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

@Nullable
public SearchFieldType getFieldType()

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

Returns:

fieldType

getMissing

@Nullable
public String getMissing()

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

Returns:

missing

build

public ProductSearchFacetDistinctValue build()

builds ProductSearchFacetDistinctValue with checking for non-null required values

Specified by:

build in interface Builder<ProductSearchFacetDistinctValue>

Returns:

ProductSearchFacetDistinctValue

buildUnchecked

public ProductSearchFacetDistinctValue buildUnchecked()

builds ProductSearchFacetDistinctValue without checking for non-null required values

Returns:

ProductSearchFacetDistinctValue

of

public static ProductSearchFacetDistinctValueBuilder of()

factory method for an instance of ProductSearchFacetDistinctValueBuilder

Returns:

builder

of

public static ProductSearchFacetDistinctValueBuilder of(ProductSearchFacetDistinctValue template)

create builder for ProductSearchFacetDistinctValue instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder