Package com.commercetools.importapi.models.importcontainers

Interface ImportContainerPagedResponse

All Known Implementing Classes:

ImportContainerPagedResponseImpl

public interface ImportContainerPagedResponse

PagedQueryResult for ImportContainers. Used as a response to a query request for ImportContainers.

Example to create an instance using the builder pattern

     ImportContainerPagedResponse importContainerPagedResponse = ImportContainerPagedResponse.builder()
             .limit(1)
             .offset(1)
             .count(1)
             .total(1)
             .plusResults(resultsBuilder -> resultsBuilder)
             .build()
 

Method Summary

Modifier and Type	Method	Description
static ImportContainerPagedResponseBuilder	builder()	builder factory method for ImportContainerPagedResponse
static ImportContainerPagedResponseBuilder	builder(ImportContainerPagedResponse template)	create builder for ImportContainerPagedResponse instance
static ImportContainerPagedResponse	deepCopy(ImportContainerPagedResponse template)	factory method to create a deep copy of ImportContainerPagedResponse
@NotNull Long	getCount()	The actual number of results returned.
@NotNull Integer	getLimit()	Number of results requested.
@NotNull Long	getOffset()	Number of elements skipped.
@NotNull @Valid List<ImportContainer>	getResults()	The array of Import Containers matching the query.
@NotNull Long	getTotal()	The total number of results matching the query.
static ImportContainerPagedResponse	of()	factory method
static ImportContainerPagedResponse	of(ImportContainerPagedResponse template)	factory method to create a shallow copy ImportContainerPagedResponse
void	setCount(Long count)	The actual number of results returned.
void	setLimit(Integer limit)	Number of results requested.
void	setOffset(Long offset)	Number of elements skipped.
void	setResults(ImportContainer... results)	The array of Import Containers matching the query.
void	setResults(List<ImportContainer> results)	The array of Import Containers matching the query.
void	setTotal(Long total)	The total number of results matching the query.
static com.fasterxml.jackson.core.type.TypeReference<ImportContainerPagedResponse>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withImportContainerPagedResponse(Function<ImportContainerPagedResponse,T> helper)	accessor map function

Method Details

getLimit

@NotNull
@NotNull Integer getLimit()

Number of results requested.

Returns:

limit

getOffset

@NotNull
@NotNull Long getOffset()

Number of elements skipped.

Returns:

offset

getCount

@NotNull
@NotNull Long getCount()

The actual number of results returned.

Returns:

count

getTotal

@NotNull
@NotNull Long getTotal()

The total number of results matching the query.

Returns:

total

getResults

@NotNull
@Valid
@NotNull @Valid List<ImportContainer> getResults()

The array of Import Containers matching the query.

Returns:

results

setLimit

void setLimit(Integer limit)

Number of results requested.

Parameters:

limit - value to be set

setOffset

void setOffset(Long offset)

Number of elements skipped.

Parameters:

offset - value to be set

setCount

void setCount(Long count)

The actual number of results returned.

Parameters:

count - value to be set

setTotal

void setTotal(Long total)

The total number of results matching the query.

Parameters:

total - value to be set

setResults

void setResults(ImportContainer... results)

The array of Import Containers matching the query.

Parameters:

results - values to be set

setResults

void setResults(List<ImportContainer> results)

The array of Import Containers matching the query.

Parameters:

results - values to be set

of

static ImportContainerPagedResponse of()

factory method

Returns:

instance of ImportContainerPagedResponse

of

static ImportContainerPagedResponse of(ImportContainerPagedResponse template)

factory method to create a shallow copy ImportContainerPagedResponse

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static ImportContainerPagedResponse deepCopy(@Nullable
 ImportContainerPagedResponse template)

factory method to create a deep copy of ImportContainerPagedResponse

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static ImportContainerPagedResponseBuilder builder()

builder factory method for ImportContainerPagedResponse

Returns:

builder

builder

static ImportContainerPagedResponseBuilder builder(ImportContainerPagedResponse template)

create builder for ImportContainerPagedResponse instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withImportContainerPagedResponse

default <T> T withImportContainerPagedResponse(Function<ImportContainerPagedResponse,T> helper)

accessor map function

Type Parameters:

T - mapped type

Parameters:

helper - function to map the object

Returns:

mapped value

typeReference

static com.fasterxml.jackson.core.type.TypeReference<ImportContainerPagedResponse> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference