Package 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	Description
static SimilarProductsTaskStatusBuilder	builder()	builder factory method for SimilarProductsTaskStatus
static SimilarProductsTaskStatusBuilder	builder(SimilarProductsTaskStatus template)	create builder for SimilarProductsTaskStatus instance
static SimilarProductsTaskStatus	deepCopy(SimilarProductsTaskStatus template)	factory method to create a deep copy of SimilarProductsTaskStatus
ZonedDateTime	getExpires()	The expiry date of the result.
@NotNull @Valid SimilarProductsPagedQueryResult	getResult()	The response to an asynchronous request.
@NotNull TaskStatusEnum	getState()
static SimilarProductsTaskStatus	of()	factory method
static SimilarProductsTaskStatus	of(SimilarProductsTaskStatus template)	factory method to create a shallow copy SimilarProductsTaskStatus
void	setExpires(ZonedDateTime expires)	The expiry date of the result.
void	setResult(SimilarProductsPagedQueryResult result)	The response to an asynchronous request.
void	setState(TaskStatusEnum state)	set state
static com.fasterxml.jackson.core.type.TypeReference<SimilarProductsTaskStatus>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withSimilarProductsTaskStatus(Function<SimilarProductsTaskStatus,T> helper)	accessor map function

Method Details

getState

@NotNull
@NotNull TaskStatusEnum getState()

Returns:

state

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.

Returns:

expires

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.

Returns:

result

setState

void setState(TaskStatusEnum state)

set state

Parameters:

state - value to be set

setExpires

void setExpires(ZonedDateTime expires)

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.

Parameters:

expires - value to be set

setResult

void setResult(SimilarProductsPagedQueryResult result)

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

Parameters:

result - value to be set

of

static SimilarProductsTaskStatus of()

factory method

Returns:

instance of SimilarProductsTaskStatus

of

static SimilarProductsTaskStatus of(SimilarProductsTaskStatus template)

factory method to create a shallow copy SimilarProductsTaskStatus

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static SimilarProductsTaskStatus deepCopy(@Nullable
 SimilarProductsTaskStatus template)

factory method to create a deep copy of SimilarProductsTaskStatus

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static SimilarProductsTaskStatusBuilder builder()

builder factory method for SimilarProductsTaskStatus

Returns:

builder

builder

static SimilarProductsTaskStatusBuilder builder(SimilarProductsTaskStatus template)

create builder for SimilarProductsTaskStatus instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withSimilarProductsTaskStatus

default <T> T withSimilarProductsTaskStatus(Function<SimilarProductsTaskStatus,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<SimilarProductsTaskStatus> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference