com.commercetools.ml.models.image_search

Interface ImageSearchResponse

All Known Implementing Classes:

ImageSearchResponseImpl

public interface ImageSearchResponse

Response format from image search endpoint.

Example to create an instance using the builder pattern

     ImageSearchResponse imageSearchResponse = ImageSearchResponse.builder()
             .count(0.3)
             .offset(0.3)
             .total(0.3)
             .plusResults(resultsBuilder -> resultsBuilder)
             .build()
 

Method Summary

Modifier and Type	Method and Description
static ImageSearchResponseBuilder	builder()
static ImageSearchResponseBuilder	builder(ImageSearchResponse template)
@NotNull Integer	getCount() The maximum number of results to return from a query.
@NotNull Double	getOffset() Number of elements skipped.
@NotNull @Valid List<ResultItem>	getResults() An array of image URLs of images that are similar to the query image.
@NotNull Integer	getTotal() The total number of product images that were have been analyzed.
static ImageSearchResponse	of()
static ImageSearchResponse	of(ImageSearchResponse template)
void	setCount(Integer count)
void	setOffset(Double offset)
void	setResults(List<ResultItem> results)
void	setResults(ResultItem... results)
void	setTotal(Integer total)
static com.fasterxml.jackson.core.type.TypeReference<ImageSearchResponse>	typeReference()
default <T> T	withImageSearchResponse(Function<ImageSearchResponse,T> helper)

Method Detail

getCount

@NotNull
@NotNull Integer getCount()

The maximum number of results to return from a query.

getOffset

@NotNull
@NotNull Double getOffset()

Number of elements skipped.

getTotal

@NotNull
@NotNull Integer getTotal()

The total number of product images that were have been analyzed.

getResults

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

An array of image URLs of images that are similar to the query image. If no matching images are found, results is empty.

setCount

void setCount(Integer count)

setOffset

void setOffset(Double offset)

setTotal

void setTotal(Integer total)

setResults

void setResults(ResultItem... results)

setResults

void setResults(List<ResultItem> results)

of

static ImageSearchResponse of()

of

static ImageSearchResponse of(ImageSearchResponse template)

builder

static ImageSearchResponseBuilder builder()

builder

static ImageSearchResponseBuilder builder(ImageSearchResponse template)

withImageSearchResponse

default <T> T withImageSearchResponse(Function<ImageSearchResponse,T> helper)

typeReference

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