com.commercetools.ml.models.similar_products

Interface SimilarProductsTaskStatus

All Known Implementing Classes:

SimilarProductsTaskStatusImpl

public interface SimilarProductsTaskStatus

Represents a URL path to poll to get the results of an Asynchronous Request.

Example to create an instance using the builder pattern

     SimilarProductsTaskStatus similarProductsTaskStatus = SimilarProductsTaskStatus.builder()
             .state(TaskStatusEnum.PENDING)
             .result(resultBuilder -> resultBuilder)
             .build()
 

Method Summary

Modifier and Type	Method and Description
static SimilarProductsTaskStatusBuilder	builder()
static SimilarProductsTaskStatusBuilder	builder(SimilarProductsTaskStatus template)
ZonedDateTime	getExpires() The expiry date of the result.
@NotNull @Valid SimilarProductsPagedQueryResult	getResult() The response to an asynchronous request.
@NotNull TaskStatusEnum	getState()
static SimilarProductsTaskStatus	of()
static SimilarProductsTaskStatus	of(SimilarProductsTaskStatus template)
void	setExpires(ZonedDateTime expires)
void	setResult(SimilarProductsPagedQueryResult result)
void	setState(TaskStatusEnum state)
static com.fasterxml.jackson.core.type.TypeReference<SimilarProductsTaskStatus>	typeReference()
default <T> T	withSimilarProductsTaskStatus(Function<SimilarProductsTaskStatus,T> helper)

Method Detail

getState

@NotNull
@NotNull TaskStatusEnum getState()

getExpires

ZonedDateTime getExpires()

The expiry date of the result. You cannot access the result after the expiry date. Default: 1 day after the result first becomes available. This is only available when the TaskStatus state is SUCCESS.

getResult

@NotNull
 @Valid
@NotNull @Valid SimilarProductsPagedQueryResult getResult()

The response to an asynchronous request. The type depends on the request initiated. Only populated when the status is SUCCESS.

setState

void setState(TaskStatusEnum state)

setExpires

void setExpires(ZonedDateTime expires)

setResult

void setResult(SimilarProductsPagedQueryResult result)

of

static SimilarProductsTaskStatus of()

of

static SimilarProductsTaskStatus of(SimilarProductsTaskStatus template)

builder

static SimilarProductsTaskStatusBuilder builder()

builder

static SimilarProductsTaskStatusBuilder builder(SimilarProductsTaskStatus template)

withSimilarProductsTaskStatus

default <T> T withSimilarProductsTaskStatus(Function<SimilarProductsTaskStatus,T> helper)

typeReference

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