Package com.commercetools.api.models.product_selection

Class ProductsInStorePagedQueryResponseBuilder

java.lang.Object

com.commercetools.api.models.product_selection.ProductsInStorePagedQueryResponseBuilder

All Implemented Interfaces:

Builder<ProductsInStorePagedQueryResponse>

public class ProductsInStorePagedQueryResponseBuilder
extends Object
implements Builder<ProductsInStorePagedQueryResponse>

ProductsInStorePagedQueryResponseBuilder Example to create an instance using the builder pattern

     ProductsInStorePagedQueryResponse productsInStorePagedQueryResponse = ProductsInStorePagedQueryResponse.builder()
             .limit(0.3)
             .offset(0.3)
             .count(0.3)
             .plusResults(resultsBuilder -> resultsBuilder)
             .build()
 

Constructor Summary

Constructors

Constructor	Description
ProductsInStorePagedQueryResponseBuilder()

Method Summary

Modifier and Type	Method	Description
ProductsInStorePagedQueryResponseBuilder	addResults(Function<ProductSelectionAssignmentBuilder,ProductSelectionAssignment> builder)	ProductSelectionAssignments matching the query.
ProductsInStorePagedQueryResponse	build()	builds ProductsInStorePagedQueryResponse with checking for non-null required values
ProductsInStorePagedQueryResponse	buildUnchecked()	builds ProductsInStorePagedQueryResponse without checking for non-null required values
ProductsInStorePagedQueryResponseBuilder	count(Long count)	Actual number of results returned.
Long	getCount()	Actual number of results returned.
Long	getLimit()	Number of results requested.
Long	getOffset()	Number of elements skipped.
List<ProductSelectionAssignment>	getResults()	ProductSelectionAssignments matching the query.
Long	getTotal()	Total number of results matching the query.
ProductsInStorePagedQueryResponseBuilder	limit(Long limit)	Number of results requested.
static ProductsInStorePagedQueryResponseBuilder	of()	factory method for an instance of ProductsInStorePagedQueryResponseBuilder
static ProductsInStorePagedQueryResponseBuilder	of(ProductsInStorePagedQueryResponse template)	create builder for ProductsInStorePagedQueryResponse instance
ProductsInStorePagedQueryResponseBuilder	offset(Long offset)	Number of elements skipped.
ProductsInStorePagedQueryResponseBuilder	plusResults(ProductSelectionAssignment... results)	ProductSelectionAssignments matching the query.
ProductsInStorePagedQueryResponseBuilder	plusResults(Function<ProductSelectionAssignmentBuilder,ProductSelectionAssignmentBuilder> builder)	ProductSelectionAssignments matching the query.
ProductsInStorePagedQueryResponseBuilder	results(ProductSelectionAssignment... results)	ProductSelectionAssignments matching the query.
ProductsInStorePagedQueryResponseBuilder	results(List<ProductSelectionAssignment> results)	ProductSelectionAssignments matching the query.
ProductsInStorePagedQueryResponseBuilder	setResults(Function<ProductSelectionAssignmentBuilder,ProductSelectionAssignment> builder)	ProductSelectionAssignments matching the query.
ProductsInStorePagedQueryResponseBuilder	total(Long total)	Total number of results matching the query.
ProductsInStorePagedQueryResponseBuilder	withResults(Function<ProductSelectionAssignmentBuilder,ProductSelectionAssignmentBuilder> builder)	ProductSelectionAssignments matching the query.

Methods inherited from class java.lang.Object

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

Constructor Details

ProductsInStorePagedQueryResponseBuilder

public ProductsInStorePagedQueryResponseBuilder()

Method Details

limit

public ProductsInStorePagedQueryResponseBuilder limit(Long limit)

Number of results requested.

Parameters:

limit - value to be set

Returns:

Builder

offset

public ProductsInStorePagedQueryResponseBuilder offset(Long offset)

Number of elements skipped.

Parameters:

offset - value to be set

Returns:

Builder

count

public ProductsInStorePagedQueryResponseBuilder count(Long count)

Actual number of results returned.

Parameters:

count - value to be set

Returns:

Builder

total

public ProductsInStorePagedQueryResponseBuilder total(@Nullable
 Long total)

Total number of results matching the query. This number is an estimation that is not strongly consistent. Unlike other endpoints, the Product Selection endpoint does not return this field by default. To get total, pass the query parameter withTotal set to true. When the results are filtered with a Query Predicate, total is subject to a limit.

Parameters:

total - value to be set

Returns:

Builder

results

public ProductsInStorePagedQueryResponseBuilder results(ProductSelectionAssignment... results)

ProductSelectionAssignments matching the query.

Parameters:

results - value to be set

Returns:

Builder

results

public ProductsInStorePagedQueryResponseBuilder results(List<ProductSelectionAssignment> results)

ProductSelectionAssignments matching the query.

Parameters:

results - value to be set

Returns:

Builder

plusResults

public ProductsInStorePagedQueryResponseBuilder plusResults(ProductSelectionAssignment... results)

ProductSelectionAssignments matching the query.

Parameters:

results - value to be set

Returns:

Builder

plusResults

public ProductsInStorePagedQueryResponseBuilder plusResults(Function<ProductSelectionAssignmentBuilder,ProductSelectionAssignmentBuilder> builder)

ProductSelectionAssignments matching the query.

Parameters:

builder - function to build the results value

Returns:

Builder

withResults

public ProductsInStorePagedQueryResponseBuilder withResults(Function<ProductSelectionAssignmentBuilder,ProductSelectionAssignmentBuilder> builder)

ProductSelectionAssignments matching the query.

Parameters:

builder - function to build the results value

Returns:

Builder

addResults

public ProductsInStorePagedQueryResponseBuilder addResults(Function<ProductSelectionAssignmentBuilder,ProductSelectionAssignment> builder)

ProductSelectionAssignments matching the query.

Parameters:

builder - function to build the results value

Returns:

Builder

setResults

public ProductsInStorePagedQueryResponseBuilder setResults(Function<ProductSelectionAssignmentBuilder,ProductSelectionAssignment> builder)

ProductSelectionAssignments matching the query.

Parameters:

builder - function to build the results value

Returns:

Builder

getLimit

public Long getLimit()

Number of results requested.

Returns:

limit

getOffset

public Long getOffset()

Number of elements skipped.

Returns:

offset

getCount

public Long getCount()

Actual number of results returned.

Returns:

count

getTotal

@Nullable
public Long getTotal()

Total number of results matching the query. This number is an estimation that is not strongly consistent. Unlike other endpoints, the Product Selection endpoint does not return this field by default. To get total, pass the query parameter withTotal set to true. When the results are filtered with a Query Predicate, total is subject to a limit.

Returns:

total

getResults

public List<ProductSelectionAssignment> getResults()

ProductSelectionAssignments matching the query.

Returns:

results

build

public ProductsInStorePagedQueryResponse build()

builds ProductsInStorePagedQueryResponse with checking for non-null required values

Specified by:

build in interface Builder<ProductsInStorePagedQueryResponse>

Returns:

ProductsInStorePagedQueryResponse

buildUnchecked

public ProductsInStorePagedQueryResponse buildUnchecked()

builds ProductsInStorePagedQueryResponse without checking for non-null required values

Returns:

ProductsInStorePagedQueryResponse

of

public static ProductsInStorePagedQueryResponseBuilder of()

factory method for an instance of ProductsInStorePagedQueryResponseBuilder

Returns:

builder

of

public static ProductsInStorePagedQueryResponseBuilder of(ProductsInStorePagedQueryResponse template)

create builder for ProductsInStorePagedQueryResponse instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder