Package com.commercetools.importapi.models.importrequests

Interface ImportRequest

All Known Subinterfaces:

CategoryImportRequest, CustomerImportRequest, InventoryImportRequest, OrderImportRequest, OrderPatchImportRequest, PriceImportRequest, ProductDraftImportRequest, ProductImportRequest, ProductTypeImportRequest, ProductVariantImportRequest, ProductVariantPatchRequest, StandalonePriceImportRequest, TypeImportRequest

All Known Implementing Classes:

CategoryImportRequestImpl, CustomerImportRequestImpl, ImportRequestImpl, InventoryImportRequestImpl, OrderImportRequestImpl, OrderPatchImportRequestImpl, PriceImportRequestImpl, ProductDraftImportRequestImpl, ProductImportRequestImpl, ProductTypeImportRequestImpl, ProductVariantImportRequestImpl, ProductVariantPatchRequestImpl, StandalonePriceImportRequestImpl, TypeImportRequestImpl

public interface ImportRequest

An import request batches multiple import resources of the same import resource type for processing by an import container.

Example to create a subtype instance using the builder pattern

     ImportRequest importRequest = ImportRequest.categoryBuilder()
             plusResources(resourcesBuilder -> resourcesBuilder)
             .build()
 

Method Summary

Modifier and Type	Method	Description
static CategoryImportRequestBuilder	categoryBuilder()	builder for category subtype
static CustomerImportRequestBuilder	customerBuilder()	builder for customer subtype
static ImportRequest	deepCopy(ImportRequest template)	factory method to create a deep copy of ImportRequest
@NotNull ImportResourceType	getType()	The resource types that can be imported.
static InventoryImportRequestBuilder	inventoryBuilder()	builder for inventory subtype
static OrderImportRequestBuilder	orderBuilder()	builder for order subtype
static OrderPatchImportRequestBuilder	orderPatchBuilder()	builder for orderPatch subtype
static PriceImportRequestBuilder	priceBuilder()	builder for price subtype
static ProductImportRequestBuilder	productBuilder()	builder for product subtype
static ProductDraftImportRequestBuilder	productDraftBuilder()	builder for productDraft subtype
static ProductTypeImportRequestBuilder	productTypeBuilder()	builder for productType subtype
static ProductVariantImportRequestBuilder	productVariantBuilder()	builder for productVariant subtype
static ProductVariantPatchRequestBuilder	productVariantPatchBuilder()	builder for productVariantPatch subtype
static StandalonePriceImportRequestBuilder	standalonePriceBuilder()	builder for standalonePrice subtype
static TypeImportRequestBuilder	typeBuilder()	builder for type subtype
static com.fasterxml.jackson.core.type.TypeReference<ImportRequest>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withImportRequest(Function<ImportRequest,T> helper)	accessor map function

Method Details

getType

@NotNull
@NotNull ImportResourceType getType()

The resource types that can be imported.

Returns:

type

deepCopy

@Nullable
static ImportRequest deepCopy(@Nullable
 ImportRequest template)

factory method to create a deep copy of ImportRequest

Parameters:

template - instance to be copied

Returns:

copy instance

categoryBuilder

static CategoryImportRequestBuilder categoryBuilder()

builder for category subtype

Returns:

builder

customerBuilder

static CustomerImportRequestBuilder customerBuilder()

builder for customer subtype

Returns:

builder

inventoryBuilder

static InventoryImportRequestBuilder inventoryBuilder()

builder for inventory subtype

Returns:

builder

orderBuilder

static OrderImportRequestBuilder orderBuilder()

builder for order subtype

Returns:

builder

orderPatchBuilder

static OrderPatchImportRequestBuilder orderPatchBuilder()

builder for orderPatch subtype

Returns:

builder

priceBuilder

static PriceImportRequestBuilder priceBuilder()

builder for price subtype

Returns:

builder

productDraftBuilder

static ProductDraftImportRequestBuilder productDraftBuilder()

builder for productDraft subtype

Returns:

builder

productBuilder

static ProductImportRequestBuilder productBuilder()

builder for product subtype

Returns:

builder

productTypeBuilder

static ProductTypeImportRequestBuilder productTypeBuilder()

builder for productType subtype

Returns:

builder

productVariantBuilder

static ProductVariantImportRequestBuilder productVariantBuilder()

builder for productVariant subtype

Returns:

builder

productVariantPatchBuilder

static ProductVariantPatchRequestBuilder productVariantPatchBuilder()

builder for productVariantPatch subtype

Returns:

builder

standalonePriceBuilder

static StandalonePriceImportRequestBuilder standalonePriceBuilder()

builder for standalonePrice subtype

Returns:

builder

typeBuilder

static TypeImportRequestBuilder typeBuilder()

builder for type subtype

Returns:

builder

withImportRequest

default <T> T withImportRequest(Function<ImportRequest,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<ImportRequest> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference