Package com.commercetools.api.models.product_search

Class ProductPagedSearchResponseBuilder

java.lang.Object

com.commercetools.api.models.product_search.ProductPagedSearchResponseBuilder

All Implemented Interfaces:

io.vrap.rmf.base.client.Builder<ProductPagedSearchResponse>

public class ProductPagedSearchResponseBuilder
extends Object
implements io.vrap.rmf.base.client.Builder<ProductPagedSearchResponse>

ProductPagedSearchResponseBuilder Example to create an instance using the builder pattern

     ProductPagedSearchResponse productPagedSearchResponse = ProductPagedSearchResponse.builder()
             .total(0.3)
             .plusHits(hitsBuilder -> hitsBuilder)
             .build()
 

Constructor Summary

Constructors

Constructor	Description
ProductPagedSearchResponseBuilder()

Method Summary

Modifier and Type	Method	Description
ProductPagedSearchResponseBuilder	addHits(Function<ProductSearchHitBuilder,ProductSearchHit> builder)	Actual results.
ProductPagedSearchResponse	build()	builds ProductPagedSearchResponse with checking for non-null required values
ProductPagedSearchResponse	buildUnchecked()	builds ProductPagedSearchResponse without checking for non-null required values
ProductPagedSearchResponseBuilder	facets(ProductSearchFacetResult facets)	Results of faceting.
ProductPagedSearchResponseBuilder	facets(Function<ProductSearchFacetResultBuilder,ProductSearchFacetResultBuilder> builder)	Results of faceting.
ProductSearchFacetResult	getFacets()	Results of faceting.
List<ProductSearchHit>	getHits()	Actual results.
Integer	getLimit()	Number of results requested.
Integer	getOffset()	Number of elements skipped.
Long	getTotal()	Total number of results matching the query.
ProductPagedSearchResponseBuilder	hits(ProductSearchHit... hits)	Actual results.
ProductPagedSearchResponseBuilder	hits(List<ProductSearchHit> hits)	Actual results.
ProductPagedSearchResponseBuilder	limit(Integer limit)	Number of results requested.
static ProductPagedSearchResponseBuilder	of()	factory method for an instance of ProductPagedSearchResponseBuilder
static ProductPagedSearchResponseBuilder	of(ProductPagedSearchResponse template)	create builder for ProductPagedSearchResponse instance
ProductPagedSearchResponseBuilder	offset(Integer offset)	Number of elements skipped.
ProductPagedSearchResponseBuilder	plusHits(ProductSearchHit... hits)	Actual results.
ProductPagedSearchResponseBuilder	plusHits(Function<ProductSearchHitBuilder,ProductSearchHitBuilder> builder)	Actual results.
ProductPagedSearchResponseBuilder	setHits(Function<ProductSearchHitBuilder,ProductSearchHit> builder)	Actual results.
ProductPagedSearchResponseBuilder	total(Long total)	Total number of results matching the query.
ProductPagedSearchResponseBuilder	withFacets(Function<ProductSearchFacetResultBuilder,ProductSearchFacetResult> builder)	Results of faceting.
ProductPagedSearchResponseBuilder	withHits(Function<ProductSearchHitBuilder,ProductSearchHitBuilder> builder)	Actual results.

Methods inherited from class java.lang.Object

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

Constructor Details

ProductPagedSearchResponseBuilder

public ProductPagedSearchResponseBuilder()

Method Details

total

public ProductPagedSearchResponseBuilder total(Long total)

Total number of results matching the query.

Parameters:

total - value to be set

Returns:

Builder

offset

public ProductPagedSearchResponseBuilder offset(@Nullable
 Integer offset)

Number of elements skipped.

Parameters:

offset - value to be set

Returns:

Builder

limit

public ProductPagedSearchResponseBuilder limit(@Nullable
 Integer limit)

Number of results requested.

Parameters:

limit - value to be set

Returns:

Builder

facets

public ProductPagedSearchResponseBuilder facets(Function<ProductSearchFacetResultBuilder,ProductSearchFacetResultBuilder> builder)

Results of faceting.

Parameters:

builder - function to build the facets value

Returns:

Builder

withFacets

public ProductPagedSearchResponseBuilder withFacets(Function<ProductSearchFacetResultBuilder,ProductSearchFacetResult> builder)

Results of faceting.

Parameters:

builder - function to build the facets value

Returns:

Builder

facets

public ProductPagedSearchResponseBuilder facets(@Nullable
 ProductSearchFacetResult facets)

Results of faceting.

Parameters:

facets - value to be set

Returns:

Builder

hits

public ProductPagedSearchResponseBuilder hits(ProductSearchHit... hits)

Actual results.

Parameters:

hits - value to be set

Returns:

Builder

hits

public ProductPagedSearchResponseBuilder hits(List<ProductSearchHit> hits)

Actual results.

Parameters:

hits - value to be set

Returns:

Builder

plusHits

public ProductPagedSearchResponseBuilder plusHits(ProductSearchHit... hits)

Actual results.

Parameters:

hits - value to be set

Returns:

Builder

plusHits

public ProductPagedSearchResponseBuilder plusHits(Function<ProductSearchHitBuilder,ProductSearchHitBuilder> builder)

Actual results.

Parameters:

builder - function to build the hits value

Returns:

Builder

withHits

public ProductPagedSearchResponseBuilder withHits(Function<ProductSearchHitBuilder,ProductSearchHitBuilder> builder)

Actual results.

Parameters:

builder - function to build the hits value

Returns:

Builder

addHits

public ProductPagedSearchResponseBuilder addHits(Function<ProductSearchHitBuilder,ProductSearchHit> builder)

Actual results.

Parameters:

builder - function to build the hits value

Returns:

Builder

setHits

public ProductPagedSearchResponseBuilder setHits(Function<ProductSearchHitBuilder,ProductSearchHit> builder)

Actual results.

Parameters:

builder - function to build the hits value

Returns:

Builder

getTotal

public Long getTotal()

Total number of results matching the query.

Returns:

total

getOffset

@Nullable
public Integer getOffset()

Number of elements skipped.

Returns:

offset

getLimit

@Nullable
public Integer getLimit()

Number of results requested.

Returns:

limit

getFacets

@Nullable
public ProductSearchFacetResult getFacets()

Results of faceting.

Returns:

facets

getHits

public List<ProductSearchHit> getHits()

Actual results.

Returns:

hits

build

public ProductPagedSearchResponse build()

builds ProductPagedSearchResponse with checking for non-null required values

Specified by:

build in interface io.vrap.rmf.base.client.Builder<ProductPagedSearchResponse>

Returns:

ProductPagedSearchResponse

buildUnchecked

public ProductPagedSearchResponse buildUnchecked()

builds ProductPagedSearchResponse without checking for non-null required values

Returns:

ProductPagedSearchResponse

of

public static ProductPagedSearchResponseBuilder of()

factory method for an instance of ProductPagedSearchResponseBuilder

Returns:

builder

of

public static ProductPagedSearchResponseBuilder of(ProductPagedSearchResponse template)

create builder for ProductPagedSearchResponse instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder