Package com.commercetools.api.models.product_search

Class ProductSearchRequestBuilder

java.lang.Object

com.commercetools.api.models.product_search.ProductSearchRequestBuilder

All Implemented Interfaces:

Builder<ProductSearchRequest>

public class ProductSearchRequestBuilder
extends Object
implements Builder<ProductSearchRequest>

ProductSearchRequestBuilder Example to create an instance using the builder pattern

     ProductSearchRequest productSearchRequest = ProductSearchRequest.builder()
             .build()
 

Constructor Summary

Constructors

Constructor	Description
ProductSearchRequestBuilder()

Method Summary

Modifier and Type	Method	Description
ProductSearchRequestBuilder	addFacets(Function<ProductSearchFacetExpressionBuilder,ProductSearchFacetExpression> builder)	Set this field to request facets.
ProductSearchRequestBuilder	addSort(Function<SearchSortingBuilder,SearchSorting> builder)	Controls how results to your query are sorted.
ProductSearchRequest	build()	builds ProductSearchRequest with checking for non-null required values
ProductSearchRequest	buildUnchecked()	builds ProductSearchRequest without checking for non-null required values
ProductSearchRequestBuilder	facets(ProductSearchFacetExpression... facets)	Set this field to request facets.
ProductSearchRequestBuilder	facets(List<ProductSearchFacetExpression> facets)	Set this field to request facets.
List<ProductSearchFacetExpression>	getFacets()	Set this field to request facets.
Integer	getLimit()	The maximum number of search results to be returned in one page.
Boolean	getMarkMatchingVariants()	The search can return Products where not all Product Variants match the search criteria.
Integer	getOffset()	The number of search results to be skipped in the response for pagination.
SearchQuery	getPostFilter()	Specify an additional filter on the result of the query after the API calculated facets.
ProductSearchProjectionParams	getProductProjectionParameters()	Controls data integration with Product Projection parameters.
SearchQuery	getQuery()	The search query against searchable Product fields.
List<SearchSorting>	getSort()	Controls how results to your query are sorted.
ProductSearchRequestBuilder	limit(Integer limit)	The maximum number of search results to be returned in one page.
ProductSearchRequestBuilder	markMatchingVariants(Boolean markMatchingVariants)	The search can return Products where not all Product Variants match the search criteria.
static ProductSearchRequestBuilder	of()	factory method for an instance of ProductSearchRequestBuilder
static ProductSearchRequestBuilder	of(ProductSearchRequest template)	create builder for ProductSearchRequest instance
ProductSearchRequestBuilder	offset(Integer offset)	The number of search results to be skipped in the response for pagination.
ProductSearchRequestBuilder	plusFacets(ProductSearchFacetExpression... facets)	Set this field to request facets.
ProductSearchRequestBuilder	plusFacets(Function<ProductSearchFacetExpressionBuilder,ProductSearchFacetExpressionBuilder> builder)	Set this field to request facets.
ProductSearchRequestBuilder	plusSort(SearchSorting... sort)	Controls how results to your query are sorted.
ProductSearchRequestBuilder	plusSort(Function<SearchSortingBuilder,SearchSortingBuilder> builder)	Controls how results to your query are sorted.
ProductSearchRequestBuilder	postFilter(SearchQuery postFilter)	Specify an additional filter on the result of the query after the API calculated facets.
ProductSearchRequestBuilder	postFilter(Function<SearchQueryBuilder,SearchQueryBuilder> builder)	Specify an additional filter on the result of the query after the API calculated facets.
ProductSearchRequestBuilder	productProjectionParameters(ProductSearchProjectionParams productProjectionParameters)	Controls data integration with Product Projection parameters.
ProductSearchRequestBuilder	productProjectionParameters(Function<ProductSearchProjectionParamsBuilder,ProductSearchProjectionParamsBuilder> builder)	Controls data integration with Product Projection parameters.
ProductSearchRequestBuilder	query(SearchQuery query)	The search query against searchable Product fields.
ProductSearchRequestBuilder	query(Function<SearchQueryBuilder,SearchQueryBuilder> builder)	The search query against searchable Product fields.
ProductSearchRequestBuilder	setFacets(Function<ProductSearchFacetExpressionBuilder,ProductSearchFacetExpression> builder)	Set this field to request facets.
ProductSearchRequestBuilder	setSort(Function<SearchSortingBuilder,SearchSorting> builder)	Controls how results to your query are sorted.
ProductSearchRequestBuilder	sort(SearchSorting... sort)	Controls how results to your query are sorted.
ProductSearchRequestBuilder	sort(List<SearchSorting> sort)	Controls how results to your query are sorted.
ProductSearchRequestBuilder	withFacets(Function<ProductSearchFacetExpressionBuilder,ProductSearchFacetExpressionBuilder> builder)	Set this field to request facets.
ProductSearchRequestBuilder	withPostFilter(Function<SearchQueryBuilder,SearchQuery> builder)	Specify an additional filter on the result of the query after the API calculated facets.
ProductSearchRequestBuilder	withProductProjectionParameters(Function<ProductSearchProjectionParamsBuilder,ProductSearchProjectionParams> builder)	Controls data integration with Product Projection parameters.
ProductSearchRequestBuilder	withQuery(Function<SearchQueryBuilder,SearchQuery> builder)	The search query against searchable Product fields.
ProductSearchRequestBuilder	withSort(Function<SearchSortingBuilder,SearchSortingBuilder> builder)	Controls how results to your query are sorted.

Methods inherited from class java.lang.Object

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

Constructor Details

ProductSearchRequestBuilder

public ProductSearchRequestBuilder()

Method Details

query

public ProductSearchRequestBuilder query(Function<SearchQueryBuilder,SearchQueryBuilder> builder)

The search query against searchable Product fields.

Parameters:

builder - function to build the query value

Returns:

Builder

withQuery

public ProductSearchRequestBuilder withQuery(Function<SearchQueryBuilder,SearchQuery> builder)

The search query against searchable Product fields.

Parameters:

builder - function to build the query value

Returns:

Builder

query

public ProductSearchRequestBuilder query(@Nullable
 SearchQuery query)

The search query against searchable Product fields.

Parameters:

query - value to be set

Returns:

Builder

sort

public ProductSearchRequestBuilder sort(@Nullable
 SearchSorting... sort)

Controls how results to your query are sorted. If not provided, the results are sorted by relevance score in descending order.

Parameters:

sort - value to be set

Returns:

Builder

sort

public ProductSearchRequestBuilder sort(@Nullable
 List<SearchSorting> sort)

Controls how results to your query are sorted. If not provided, the results are sorted by relevance score in descending order.

Parameters:

sort - value to be set

Returns:

Builder

plusSort

public ProductSearchRequestBuilder plusSort(@Nullable
 SearchSorting... sort)

Controls how results to your query are sorted. If not provided, the results are sorted by relevance score in descending order.

Parameters:

sort - value to be set

Returns:

Builder

plusSort

public ProductSearchRequestBuilder plusSort(Function<SearchSortingBuilder,SearchSortingBuilder> builder)

Controls how results to your query are sorted. If not provided, the results are sorted by relevance score in descending order.

Parameters:

builder - function to build the sort value

Returns:

Builder

withSort

public ProductSearchRequestBuilder withSort(Function<SearchSortingBuilder,SearchSortingBuilder> builder)

Controls how results to your query are sorted. If not provided, the results are sorted by relevance score in descending order.

Parameters:

builder - function to build the sort value

Returns:

Builder

addSort

public ProductSearchRequestBuilder addSort(Function<SearchSortingBuilder,SearchSorting> builder)

Controls how results to your query are sorted. If not provided, the results are sorted by relevance score in descending order.

Parameters:

builder - function to build the sort value

Returns:

Builder

setSort

public ProductSearchRequestBuilder setSort(Function<SearchSortingBuilder,SearchSorting> builder)

Controls how results to your query are sorted. If not provided, the results are sorted by relevance score in descending order.

Parameters:

builder - function to build the sort value

Returns:

Builder

limit

public ProductSearchRequestBuilder limit(@Nullable
 Integer limit)

The maximum number of search results to be returned in one page.

Parameters:

limit - value to be set

Returns:

Builder

offset

public ProductSearchRequestBuilder offset(@Nullable
 Integer offset)

The number of search results to be skipped in the response for pagination.

Parameters:

offset - value to be set

Returns:

Builder

markMatchingVariants

public ProductSearchRequestBuilder markMatchingVariants(@Nullable
 Boolean markMatchingVariants)

The search can return Products where not all Product Variants match the search criteria. If true, the response will include a field called matchingVariants that contains the sku of Product Variants that match the search query. If the query does not specify any variant-level criteria, matchingVariants will be null signifying that all Product Variants are a match.

Parameters:

markMatchingVariants - value to be set

Returns:

Builder

productProjectionParameters

public ProductSearchRequestBuilder productProjectionParameters(Function<ProductSearchProjectionParamsBuilder,ProductSearchProjectionParamsBuilder> builder)

Controls data integration with Product Projection parameters. If not set, the result does not include the Product Projection.

Parameters:

builder - function to build the productProjectionParameters value

Returns:

Builder

withProductProjectionParameters

public ProductSearchRequestBuilder withProductProjectionParameters(Function<ProductSearchProjectionParamsBuilder,ProductSearchProjectionParams> builder)

Controls data integration with Product Projection parameters. If not set, the result does not include the Product Projection.

Parameters:

builder - function to build the productProjectionParameters value

Returns:

Builder

productProjectionParameters

public ProductSearchRequestBuilder productProjectionParameters(@Nullable
 ProductSearchProjectionParams productProjectionParameters)

Controls data integration with Product Projection parameters. If not set, the result does not include the Product Projection.

Parameters:

productProjectionParameters - value to be set

Returns:

Builder

facets

public ProductSearchRequestBuilder facets(@Nullable
 ProductSearchFacetExpression... facets)

Set this field to request facets.

Parameters:

facets - value to be set

Returns:

Builder

facets

public ProductSearchRequestBuilder facets(@Nullable
 List<ProductSearchFacetExpression> facets)

Set this field to request facets.

Parameters:

facets - value to be set

Returns:

Builder

plusFacets

public ProductSearchRequestBuilder plusFacets(@Nullable
 ProductSearchFacetExpression... facets)

Set this field to request facets.

Parameters:

facets - value to be set

Returns:

Builder

plusFacets

public ProductSearchRequestBuilder plusFacets(Function<ProductSearchFacetExpressionBuilder,ProductSearchFacetExpressionBuilder> builder)

Set this field to request facets.

Parameters:

builder - function to build the facets value

Returns:

Builder

withFacets

public ProductSearchRequestBuilder withFacets(Function<ProductSearchFacetExpressionBuilder,ProductSearchFacetExpressionBuilder> builder)

Set this field to request facets.

Parameters:

builder - function to build the facets value

Returns:

Builder

addFacets

public ProductSearchRequestBuilder addFacets(Function<ProductSearchFacetExpressionBuilder,ProductSearchFacetExpression> builder)

Set this field to request facets.

Parameters:

builder - function to build the facets value

Returns:

Builder

setFacets

public ProductSearchRequestBuilder setFacets(Function<ProductSearchFacetExpressionBuilder,ProductSearchFacetExpression> builder)

Set this field to request facets.

Parameters:

builder - function to build the facets value

Returns:

Builder

postFilter

public ProductSearchRequestBuilder postFilter(Function<SearchQueryBuilder,SearchQueryBuilder> builder)

Specify an additional filter on the result of the query after the API calculated facets. This feature assists you in implementing faceted search.

Parameters:

builder - function to build the postFilter value

Returns:

Builder

withPostFilter

public ProductSearchRequestBuilder withPostFilter(Function<SearchQueryBuilder,SearchQuery> builder)

Specify an additional filter on the result of the query after the API calculated facets. This feature assists you in implementing faceted search.

Parameters:

builder - function to build the postFilter value

Returns:

Builder

postFilter

public ProductSearchRequestBuilder postFilter(@Nullable
 SearchQuery postFilter)

Specify an additional filter on the result of the query after the API calculated facets. This feature assists you in implementing faceted search.

Parameters:

postFilter - value to be set

Returns:

Builder

getQuery

@Nullable
public SearchQuery getQuery()

The search query against searchable Product fields.

Returns:

query

getSort

@Nullable
public List<SearchSorting> getSort()

Controls how results to your query are sorted. If not provided, the results are sorted by relevance score in descending order.

Returns:

sort

getLimit

@Nullable
public Integer getLimit()

The maximum number of search results to be returned in one page.

Returns:

limit

getOffset

@Nullable
public Integer getOffset()

The number of search results to be skipped in the response for pagination.

Returns:

offset

getMarkMatchingVariants

@Nullable
public Boolean getMarkMatchingVariants()

The search can return Products where not all Product Variants match the search criteria. If true, the response will include a field called matchingVariants that contains the sku of Product Variants that match the search query. If the query does not specify any variant-level criteria, matchingVariants will be null signifying that all Product Variants are a match.

Returns:

markMatchingVariants

getProductProjectionParameters

@Nullable
public ProductSearchProjectionParams getProductProjectionParameters()

Controls data integration with Product Projection parameters. If not set, the result does not include the Product Projection.

Returns:

productProjectionParameters

getFacets

@Nullable
public List<ProductSearchFacetExpression> getFacets()

Set this field to request facets.

Returns:

facets

getPostFilter

@Nullable
public SearchQuery getPostFilter()

Specify an additional filter on the result of the query after the API calculated facets. This feature assists you in implementing faceted search.

Returns:

postFilter

build

public ProductSearchRequest build()

builds ProductSearchRequest with checking for non-null required values

Specified by:

build in interface Builder<ProductSearchRequest>

Returns:

ProductSearchRequest

buildUnchecked

public ProductSearchRequest buildUnchecked()

builds ProductSearchRequest without checking for non-null required values

Returns:

ProductSearchRequest

of

public static ProductSearchRequestBuilder of()

factory method for an instance of ProductSearchRequestBuilder

Returns:

builder

of

public static ProductSearchRequestBuilder of(ProductSearchRequest template)

create builder for ProductSearchRequest instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder