Package com.commercetools.ml.models.similar_products

Class SimilarProductsTaskStatusBuilder

java.lang.Object

com.commercetools.ml.models.similar_products.SimilarProductsTaskStatusBuilder

All Implemented Interfaces:

Builder<SimilarProductsTaskStatus>

public class SimilarProductsTaskStatusBuilder
extends Object
implements Builder<SimilarProductsTaskStatus>

SimilarProductsTaskStatusBuilder Example to create an instance using the builder pattern

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

Constructor Summary

Constructors

Constructor	Description
SimilarProductsTaskStatusBuilder()

Method Summary

Modifier and Type	Method	Description
SimilarProductsTaskStatus	build()	builds SimilarProductsTaskStatus with checking for non-null required values
SimilarProductsTaskStatus	buildUnchecked()	builds SimilarProductsTaskStatus without checking for non-null required values
SimilarProductsTaskStatusBuilder	expires(ZonedDateTime expires)	The expiry date of the result.
ZonedDateTime	getExpires()	The expiry date of the result.
SimilarProductsPagedQueryResult	getResult()	The response to an asynchronous request.
TaskStatusEnum	getState()	value of state}
static SimilarProductsTaskStatusBuilder	of()	factory method for an instance of SimilarProductsTaskStatusBuilder
static SimilarProductsTaskStatusBuilder	of(SimilarProductsTaskStatus template)	create builder for SimilarProductsTaskStatus instance
SimilarProductsTaskStatusBuilder	result(SimilarProductsPagedQueryResult result)	The response to an asynchronous request.
SimilarProductsTaskStatusBuilder	result(Function<SimilarProductsPagedQueryResultBuilder,SimilarProductsPagedQueryResultBuilder> builder)	The response to an asynchronous request.
SimilarProductsTaskStatusBuilder	state(TaskStatusEnum state)	set the value to the state
SimilarProductsTaskStatusBuilder	withResult(Function<SimilarProductsPagedQueryResultBuilder,SimilarProductsPagedQueryResult> builder)	The response to an asynchronous request.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

SimilarProductsTaskStatusBuilder

public SimilarProductsTaskStatusBuilder()

Method Details

state

public SimilarProductsTaskStatusBuilder state(TaskStatusEnum state)

set the value to the state

Parameters:

state - value to be set

Returns:

Builder

expires

public SimilarProductsTaskStatusBuilder expires(@Nullable
 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

Returns:

Builder

result

public SimilarProductsTaskStatusBuilder result(Function<SimilarProductsPagedQueryResultBuilder,SimilarProductsPagedQueryResultBuilder> builder)

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

Parameters:

builder - function to build the result value

Returns:

Builder

withResult

public SimilarProductsTaskStatusBuilder withResult(Function<SimilarProductsPagedQueryResultBuilder,SimilarProductsPagedQueryResult> builder)

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

Parameters:

builder - function to build the result value

Returns:

Builder

result

public SimilarProductsTaskStatusBuilder result(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

Returns:

Builder

getState

public TaskStatusEnum getState()

value of state}

Returns:

state

getExpires

@Nullable
public 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

public SimilarProductsPagedQueryResult getResult()

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

Returns:

result

build

public SimilarProductsTaskStatus build()

builds SimilarProductsTaskStatus with checking for non-null required values

Specified by:

build in interface Builder<SimilarProductsTaskStatus>

Returns:

SimilarProductsTaskStatus

buildUnchecked

public SimilarProductsTaskStatus buildUnchecked()

builds SimilarProductsTaskStatus without checking for non-null required values

Returns:

SimilarProductsTaskStatus

of

public static SimilarProductsTaskStatusBuilder of()

factory method for an instance of SimilarProductsTaskStatusBuilder

Returns:

builder

of

public static SimilarProductsTaskStatusBuilder of(SimilarProductsTaskStatus template)

create builder for SimilarProductsTaskStatus instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder