com.commercetools.ml.models.image_search

Interface ResultItem

All Known Implementing Classes:

ResultItemImpl

public interface ResultItem

An image URL and the product variants it is contained in. If no matching images are found, ResultItem is not present.

Example to create an instance using the builder pattern

     ResultItem resultItem = ResultItem.builder()
             .imageUrl("{imageUrl}")
             .plusProductVariants(productVariantsBuilder -> productVariantsBuilder)
             .build()
 

Method Summary

Modifier and Type	Method and Description
static ResultItemBuilder	builder()
static ResultItemBuilder	builder(ResultItem template)
@NotNull String	getImageUrl() The URL of the image.
@NotNull @Valid List<ProductVariant>	getProductVariants() An array of product variants containing the image URL.
static ResultItem	of()
static ResultItem	of(ResultItem template)
void	setImageUrl(String imageUrl)
void	setProductVariants(List<ProductVariant> productVariants)
void	setProductVariants(ProductVariant... productVariants)
static com.fasterxml.jackson.core.type.TypeReference<ResultItem>	typeReference()
default <T> T	withResultItem(Function<ResultItem,T> helper)

Method Detail

getImageUrl

@NotNull
@NotNull String getImageUrl()

The URL of the image.

getProductVariants

@NotNull
 @Valid
@NotNull @Valid List<ProductVariant> getProductVariants()

An array of product variants containing the image URL.

setImageUrl

void setImageUrl(String imageUrl)

setProductVariants

void setProductVariants(ProductVariant... productVariants)

setProductVariants

void setProductVariants(List<ProductVariant> productVariants)

of

static ResultItem of()

of

static ResultItem of(ResultItem template)

builder

static ResultItemBuilder builder()

builder

static ResultItemBuilder builder(ResultItem template)

withResultItem

default <T> T withResultItem(Function<ResultItem,T> helper)

typeReference

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