Package com.commercetools.importapi.models.importrequests

Interface OrderImportRequest

All Superinterfaces:

ImportRequest

All Known Implementing Classes:

OrderImportRequestImpl

public interface OrderImportRequest
extends ImportRequest

The request body to import Orders. Contains data for Orders to be created in a Project.

Example to create an instance using the builder pattern

     OrderImportRequest orderImportRequest = OrderImportRequest.builder()
             .plusResources(resourcesBuilder -> resourcesBuilder)
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ORDER	discriminator value for OrderImportRequest

Method Summary

Modifier and Type	Method	Description
static OrderImportRequestBuilder	builder()	builder factory method for OrderImportRequest
static OrderImportRequestBuilder	builder(OrderImportRequest template)	create builder for OrderImportRequest instance
static OrderImportRequest	deepCopy(OrderImportRequest template)	factory method to create a deep copy of OrderImportRequest
@NotNull @Valid List<OrderImport>	getResources()	The order import resources of this request.
static OrderImportRequest	of()	factory method
static OrderImportRequest	of(OrderImportRequest template)	factory method to create a shallow copy OrderImportRequest
void	setResources(OrderImport... resources)	The order import resources of this request.
void	setResources(List<OrderImport> resources)	The order import resources of this request.
static com.fasterxml.jackson.core.type.TypeReference<OrderImportRequest>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withOrderImportRequest(Function<OrderImportRequest,T> helper)	accessor map function

Methods inherited from interface com.commercetools.importapi.models.importrequests.ImportRequest

getType, withImportRequest

Field Details

ORDER

static final String ORDER

discriminator value for OrderImportRequest

See Also:

• Constant Field Values

Method Details

getResources

@NotNull
@Valid
@NotNull @Valid List<OrderImport> getResources()

The order import resources of this request.

Returns:

resources

setResources

void setResources(OrderImport... resources)

The order import resources of this request.

Parameters:

resources - values to be set

setResources

void setResources(List<OrderImport> resources)

The order import resources of this request.

Parameters:

resources - values to be set

of

static OrderImportRequest of()

factory method

Returns:

instance of OrderImportRequest

of

static OrderImportRequest of(OrderImportRequest template)

factory method to create a shallow copy OrderImportRequest

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static OrderImportRequest deepCopy(@Nullable
 OrderImportRequest template)

factory method to create a deep copy of OrderImportRequest

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static OrderImportRequestBuilder builder()

builder factory method for OrderImportRequest

Returns:

builder

builder

static OrderImportRequestBuilder builder(OrderImportRequest template)

create builder for OrderImportRequest instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withOrderImportRequest

default <T> T withOrderImportRequest(Function<OrderImportRequest,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<OrderImportRequest> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference