Package com.commercetools.importapi.models.importoperations

Interface ImportOperationPagedResponse

All Known Implementing Classes:

ImportOperationPagedResponseImpl

public interface ImportOperationPagedResponse

PagedQueryResult for Import Operations.

Example to create an instance using the builder pattern

     ImportOperationPagedResponse importOperationPagedResponse = ImportOperationPagedResponse.builder()
             .limit(1)
             .offset(1)
             .count(1)
             .total(1)
             .plusResults(resultsBuilder -> resultsBuilder)
             .build()
 

Method Summary

Modifier and Type	Method	Description
static ImportOperationPagedResponseBuilder	builder()	builder factory method for ImportOperationPagedResponse
static ImportOperationPagedResponseBuilder	builder(ImportOperationPagedResponse template)	create builder for ImportOperationPagedResponse instance
static ImportOperationPagedResponse	deepCopy(ImportOperationPagedResponse template)	factory method to create a deep copy of ImportOperationPagedResponse
@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<ImportOperation>	getResults()	The array of Import Operations matching the query.
@NotNull Long	getTotal()	The total number of import operations matching the query.
static ImportOperationPagedResponse	of()	factory method
static ImportOperationPagedResponse	of(ImportOperationPagedResponse template)	factory method to create a shallow copy ImportOperationPagedResponse
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(ImportOperation... results)	The array of Import Operations matching the query.
void	setResults(List<ImportOperation> results)	The array of Import Operations matching the query.
void	setTotal(Long total)	The total number of import operations matching the query.
static com.fasterxml.jackson.core.type.TypeReference<ImportOperationPagedResponse>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withImportOperationPagedResponse(Function<ImportOperationPagedResponse,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 import operations matching the query.

Returns:

total

getResults

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

The array of Import Operations 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 import operations matching the query.

Parameters:

total - value to be set

setResults

void setResults(ImportOperation... results)

The array of Import Operations matching the query.

Parameters:

results - values to be set

setResults

void setResults(List<ImportOperation> results)

The array of Import Operations matching the query.

Parameters:

results - values to be set

of

static ImportOperationPagedResponse of()

factory method

Returns:

instance of ImportOperationPagedResponse

of

static ImportOperationPagedResponse of(ImportOperationPagedResponse template)

factory method to create a shallow copy ImportOperationPagedResponse

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static ImportOperationPagedResponse deepCopy(@Nullable
 ImportOperationPagedResponse template)

factory method to create a deep copy of ImportOperationPagedResponse

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static ImportOperationPagedResponseBuilder builder()

builder factory method for ImportOperationPagedResponse

Returns:

builder

builder

static ImportOperationPagedResponseBuilder builder(ImportOperationPagedResponse template)

create builder for ImportOperationPagedResponse instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withImportOperationPagedResponse

default <T> T withImportOperationPagedResponse(Function<ImportOperationPagedResponse,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<ImportOperationPagedResponse> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference