Package com.commercetools.api.models.customer_group

Class CustomerGroupPagedQueryResponseBuilder

java.lang.Object

com.commercetools.api.models.customer_group.CustomerGroupPagedQueryResponseBuilder

All Implemented Interfaces:

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

public class CustomerGroupPagedQueryResponseBuilder
extends Object
implements io.vrap.rmf.base.client.Builder<CustomerGroupPagedQueryResponse>

CustomerGroupPagedQueryResponseBuilder Example to create an instance using the builder pattern

     CustomerGroupPagedQueryResponse customerGroupPagedQueryResponse = CustomerGroupPagedQueryResponse.builder()
             .limit(0.3)
             .offset(0.3)
             .count(0.3)
             .plusResults(resultsBuilder -> resultsBuilder)
             .build()
 

Constructor Summary

Constructors

Constructor	Description
CustomerGroupPagedQueryResponseBuilder()

Method Summary

Modifier and Type	Method	Description
CustomerGroupPagedQueryResponseBuilder	addResults(Function<CustomerGroupBuilder,CustomerGroup> builder)	CustomerGroups matching the query.
CustomerGroupPagedQueryResponse	build()	builds CustomerGroupPagedQueryResponse with checking for non-null required values
CustomerGroupPagedQueryResponse	buildUnchecked()	builds CustomerGroupPagedQueryResponse without checking for non-null required values
CustomerGroupPagedQueryResponseBuilder	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<CustomerGroup>	getResults()	CustomerGroups matching the query.
Long	getTotal()	Total number of results matching the query.
CustomerGroupPagedQueryResponseBuilder	limit(Long limit)	Number of results requested.
static CustomerGroupPagedQueryResponseBuilder	of()	factory method for an instance of CustomerGroupPagedQueryResponseBuilder
static CustomerGroupPagedQueryResponseBuilder	of(CustomerGroupPagedQueryResponse template)	create builder for CustomerGroupPagedQueryResponse instance
CustomerGroupPagedQueryResponseBuilder	offset(Long offset)	Number of elements skipped.
CustomerGroupPagedQueryResponseBuilder	plusResults(CustomerGroup... results)	CustomerGroups matching the query.
CustomerGroupPagedQueryResponseBuilder	plusResults(Function<CustomerGroupBuilder,CustomerGroupBuilder> builder)	CustomerGroups matching the query.
CustomerGroupPagedQueryResponseBuilder	results(CustomerGroup... results)	CustomerGroups matching the query.
CustomerGroupPagedQueryResponseBuilder	results(List<CustomerGroup> results)	CustomerGroups matching the query.
CustomerGroupPagedQueryResponseBuilder	setResults(Function<CustomerGroupBuilder,CustomerGroup> builder)	CustomerGroups matching the query.
CustomerGroupPagedQueryResponseBuilder	total(Long total)	Total number of results matching the query.
CustomerGroupPagedQueryResponseBuilder	withResults(Function<CustomerGroupBuilder,CustomerGroupBuilder> builder)	CustomerGroups matching the query.

Methods inherited from class java.lang.Object

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

Constructor Details

CustomerGroupPagedQueryResponseBuilder

public CustomerGroupPagedQueryResponseBuilder()

Method Details

limit

public CustomerGroupPagedQueryResponseBuilder limit(Long limit)

Number of results requested.

Parameters:

limit - value to be set

Returns:

Builder

offset

public CustomerGroupPagedQueryResponseBuilder offset(Long offset)

Number of elements skipped.

Parameters:

offset - value to be set

Returns:

Builder

count

public CustomerGroupPagedQueryResponseBuilder count(Long count)

Actual number of results returned.

Parameters:

count - value to be set

Returns:

Builder

total

public CustomerGroupPagedQueryResponseBuilder total(@Nullable
 Long total)

Total number of results matching the query. This number is an estimation that is not strongly consistent. This field is returned by default. For improved performance, calculating this field can be deactivated by using the query parameter withTotal=false. 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 CustomerGroupPagedQueryResponseBuilder results(CustomerGroup... results)

CustomerGroups matching the query.

Parameters:

results - value to be set

Returns:

Builder

results

public CustomerGroupPagedQueryResponseBuilder results(List<CustomerGroup> results)

CustomerGroups matching the query.

Parameters:

results - value to be set

Returns:

Builder

plusResults

public CustomerGroupPagedQueryResponseBuilder plusResults(CustomerGroup... results)

CustomerGroups matching the query.

Parameters:

results - value to be set

Returns:

Builder

plusResults

public CustomerGroupPagedQueryResponseBuilder plusResults(Function<CustomerGroupBuilder,CustomerGroupBuilder> builder)

CustomerGroups matching the query.

Parameters:

builder - function to build the results value

Returns:

Builder

withResults

public CustomerGroupPagedQueryResponseBuilder withResults(Function<CustomerGroupBuilder,CustomerGroupBuilder> builder)

CustomerGroups matching the query.

Parameters:

builder - function to build the results value

Returns:

Builder

addResults

public CustomerGroupPagedQueryResponseBuilder addResults(Function<CustomerGroupBuilder,CustomerGroup> builder)

CustomerGroups matching the query.

Parameters:

builder - function to build the results value

Returns:

Builder

setResults

public CustomerGroupPagedQueryResponseBuilder setResults(Function<CustomerGroupBuilder,CustomerGroup> builder)

CustomerGroups 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. This field is returned by default. For improved performance, calculating this field can be deactivated by using the query parameter withTotal=false. When the results are filtered with a Query Predicate, total is subject to a limit.

Returns:

total

getResults

public List<CustomerGroup> getResults()

CustomerGroups matching the query.

Returns:

results

build

public CustomerGroupPagedQueryResponse build()

builds CustomerGroupPagedQueryResponse with checking for non-null required values

Specified by:

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

Returns:

CustomerGroupPagedQueryResponse

buildUnchecked

public CustomerGroupPagedQueryResponse buildUnchecked()

builds CustomerGroupPagedQueryResponse without checking for non-null required values

Returns:

CustomerGroupPagedQueryResponse

of

public static CustomerGroupPagedQueryResponseBuilder of()

factory method for an instance of CustomerGroupPagedQueryResponseBuilder

Returns:

builder

of

public static CustomerGroupPagedQueryResponseBuilder of(CustomerGroupPagedQueryResponse template)

create builder for CustomerGroupPagedQueryResponse instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder