Package com.commercetools.importapi.models.products

Class ProductImportBuilder

java.lang.Object

com.commercetools.importapi.models.products.ProductImportBuilder

All Implemented Interfaces:

Builder<ProductImport>

public class ProductImportBuilder
extends Object
implements Builder<ProductImport>

ProductImportBuilder Example to create an instance using the builder pattern

     ProductImport productImport = ProductImport.builder()
             .key("{key}")
             .name(nameBuilder -> nameBuilder)
             .productType(productTypeBuilder -> productTypeBuilder)
             .slug(slugBuilder -> slugBuilder)
             .build()
 

Constructor Summary

Constructors

Constructor	Description
ProductImportBuilder()

Method Summary

Modifier and Type	Method	Description
ProductImportBuilder	addCategories(Function<CategoryKeyReferenceBuilder,CategoryKeyReference> builder)	Maps to ProductData.categories.
ProductImportBuilder	attributes(Attribute... attributes)	set values to the attributes
ProductImportBuilder	attributes(List<Attribute> attributes)	set value to the attributes
ProductImport	build()	builds ProductImport with checking for non-null required values
ProductImport	buildUnchecked()	builds ProductImport without checking for non-null required values
ProductImportBuilder	categories(CategoryKeyReference... categories)	Maps to ProductData.categories.
ProductImportBuilder	categories(List<CategoryKeyReference> categories)	Maps to ProductData.categories.
ProductImportBuilder	description(LocalizedString description)	Maps to ProductData.description.
ProductImportBuilder	description(Function<LocalizedStringBuilder,LocalizedStringBuilder> builder)	Maps to ProductData.description.
List<Attribute>	getAttributes()	value of attributes}
List<CategoryKeyReference>	getCategories()	Maps to ProductData.categories.
LocalizedString	getDescription()	Maps to ProductData.description.
String	getKey()	User-defined unique identifier.
LocalizedString	getMetaDescription()	Maps to ProductData.metaDescription.
LocalizedString	getMetaKeywords()	Maps to ProductData.metaKeywords.
LocalizedString	getMetaTitle()	Maps to ProductData.metaTitle.
LocalizedString	getName()	Maps to ProductData.name.
ProductPriceModeEnum	getPriceMode()	Maps to Product.priceMode.
ProductTypeKeyReference	getProductType()	Maps to Product.productType.
Boolean	getPublish()	Determines the published status and current/staged projection of the Product.
SearchKeywords	getSearchKeywords()	Maps to ProductData.searchKeywords.
LocalizedString	getSlug()	Maps to ProductData.slug.
StateKeyReference	getState()	Maps to Product.state.
TaxCategoryKeyReference	getTaxCategory()	Maps to Product.taxCategory.
ProductImportBuilder	key(String key)	User-defined unique identifier.
ProductImportBuilder	metaDescription(LocalizedString metaDescription)	Maps to ProductData.metaDescription.
ProductImportBuilder	metaDescription(Function<LocalizedStringBuilder,LocalizedStringBuilder> builder)	Maps to ProductData.metaDescription.
ProductImportBuilder	metaKeywords(LocalizedString metaKeywords)	Maps to ProductData.metaKeywords.
ProductImportBuilder	metaKeywords(Function<LocalizedStringBuilder,LocalizedStringBuilder> builder)	Maps to ProductData.metaKeywords.
ProductImportBuilder	metaTitle(LocalizedString metaTitle)	Maps to ProductData.metaTitle.
ProductImportBuilder	metaTitle(Function<LocalizedStringBuilder,LocalizedStringBuilder> builder)	Maps to ProductData.metaTitle.
ProductImportBuilder	name(LocalizedString name)	Maps to ProductData.name.
ProductImportBuilder	name(Function<LocalizedStringBuilder,LocalizedStringBuilder> builder)	Maps to ProductData.name.
static ProductImportBuilder	of()	factory method for an instance of ProductImportBuilder
static ProductImportBuilder	of(ProductImport template)	create builder for ProductImport instance
ProductImportBuilder	plusAttributes(Attribute... attributes)	add values to the attributes
ProductImportBuilder	plusAttributes(Function<AttributeBuilder,Builder<? extends Attribute>> builder)	add a value to the attributes using the builder function
ProductImportBuilder	plusCategories(CategoryKeyReference... categories)	Maps to ProductData.categories.
ProductImportBuilder	plusCategories(Function<CategoryKeyReferenceBuilder,CategoryKeyReferenceBuilder> builder)	Maps to ProductData.categories.
ProductImportBuilder	priceMode(ProductPriceModeEnum priceMode)	Maps to Product.priceMode.
ProductImportBuilder	productType(ProductTypeKeyReference productType)	Maps to Product.productType.
ProductImportBuilder	productType(Function<ProductTypeKeyReferenceBuilder,ProductTypeKeyReferenceBuilder> builder)	Maps to Product.productType.
ProductImportBuilder	publish(Boolean publish)	Determines the published status and current/staged projection of the Product.
ProductImportBuilder	searchKeywords(SearchKeywords searchKeywords)	Maps to ProductData.searchKeywords.
ProductImportBuilder	searchKeywords(Function<SearchKeywordsBuilder,SearchKeywordsBuilder> builder)	Maps to ProductData.searchKeywords.
ProductImportBuilder	setCategories(Function<CategoryKeyReferenceBuilder,CategoryKeyReference> builder)	Maps to ProductData.categories.
ProductImportBuilder	slug(LocalizedString slug)	Maps to ProductData.slug.
ProductImportBuilder	slug(Function<LocalizedStringBuilder,LocalizedStringBuilder> builder)	Maps to ProductData.slug.
ProductImportBuilder	state(StateKeyReference state)	Maps to Product.state.
ProductImportBuilder	state(Function<StateKeyReferenceBuilder,StateKeyReferenceBuilder> builder)	Maps to Product.state.
ProductImportBuilder	taxCategory(TaxCategoryKeyReference taxCategory)	Maps to Product.taxCategory.
ProductImportBuilder	taxCategory(Function<TaxCategoryKeyReferenceBuilder,TaxCategoryKeyReferenceBuilder> builder)	Maps to Product.taxCategory.
ProductImportBuilder	withAttributes(Function<AttributeBuilder,Builder<? extends Attribute>> builder)	set the value to the attributes using the builder function
ProductImportBuilder	withCategories(Function<CategoryKeyReferenceBuilder,CategoryKeyReferenceBuilder> builder)	Maps to ProductData.categories.
ProductImportBuilder	withDescription(Function<LocalizedStringBuilder,LocalizedString> builder)	Maps to ProductData.description.
ProductImportBuilder	withMetaDescription(Function<LocalizedStringBuilder,LocalizedString> builder)	Maps to ProductData.metaDescription.
ProductImportBuilder	withMetaKeywords(Function<LocalizedStringBuilder,LocalizedString> builder)	Maps to ProductData.metaKeywords.
ProductImportBuilder	withMetaTitle(Function<LocalizedStringBuilder,LocalizedString> builder)	Maps to ProductData.metaTitle.
ProductImportBuilder	withName(Function<LocalizedStringBuilder,LocalizedString> builder)	Maps to ProductData.name.
ProductImportBuilder	withProductType(Function<ProductTypeKeyReferenceBuilder,ProductTypeKeyReference> builder)	Maps to Product.productType.
ProductImportBuilder	withSearchKeywords(Function<SearchKeywordsBuilder,SearchKeywords> builder)	Maps to ProductData.searchKeywords.
ProductImportBuilder	withSlug(Function<LocalizedStringBuilder,LocalizedString> builder)	Maps to ProductData.slug.
ProductImportBuilder	withState(Function<StateKeyReferenceBuilder,StateKeyReference> builder)	Maps to Product.state.
ProductImportBuilder	withTaxCategory(Function<TaxCategoryKeyReferenceBuilder,TaxCategoryKeyReference> builder)	Maps to Product.taxCategory.

Methods inherited from class java.lang.Object

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

Constructor Details

ProductImportBuilder

public ProductImportBuilder()

Method Details

key

public ProductImportBuilder key(String key)

User-defined unique identifier. If a Product with this key exists, it is updated with the imported data.

Parameters:

key - value to be set

Returns:

Builder

name

public ProductImportBuilder name(Function<LocalizedStringBuilder,LocalizedStringBuilder> builder)

Maps to ProductData.name.

Parameters:

builder - function to build the name value

Returns:

Builder

withName

public ProductImportBuilder withName(Function<LocalizedStringBuilder,LocalizedString> builder)

Maps to ProductData.name.

Parameters:

builder - function to build the name value

Returns:

Builder

name

public ProductImportBuilder name(LocalizedString name)

Maps to ProductData.name.

Parameters:

name - value to be set

Returns:

Builder

productType

public ProductImportBuilder productType(Function<ProductTypeKeyReferenceBuilder,ProductTypeKeyReferenceBuilder> builder)

Maps to Product.productType. If the referenced ProductType does not exist, the state of the ImportOperation will be set to unresolved until the referenced ProductType is created.

Parameters:

builder - function to build the productType value

Returns:

Builder

withProductType

public ProductImportBuilder withProductType(Function<ProductTypeKeyReferenceBuilder,ProductTypeKeyReference> builder)

Maps to Product.productType. If the referenced ProductType does not exist, the state of the ImportOperation will be set to unresolved until the referenced ProductType is created.

Parameters:

builder - function to build the productType value

Returns:

Builder

productType

public ProductImportBuilder productType(ProductTypeKeyReference productType)

Maps to Product.productType. If the referenced ProductType does not exist, the state of the ImportOperation will be set to unresolved until the referenced ProductType is created.

Parameters:

productType - value to be set

Returns:

Builder

slug

public ProductImportBuilder slug(Function<LocalizedStringBuilder,LocalizedStringBuilder> builder)

Maps to ProductData.slug.

Parameters:

builder - function to build the slug value

Returns:

Builder

withSlug

public ProductImportBuilder withSlug(Function<LocalizedStringBuilder,LocalizedString> builder)

Maps to ProductData.slug.

Parameters:

builder - function to build the slug value

Returns:

Builder

slug

public ProductImportBuilder slug(LocalizedString slug)

Maps to ProductData.slug.

Parameters:

slug - value to be set

Returns:

Builder

description

public ProductImportBuilder description(Function<LocalizedStringBuilder,LocalizedStringBuilder> builder)

Maps to ProductData.description.

Parameters:

builder - function to build the description value

Returns:

Builder

withDescription

public ProductImportBuilder withDescription(Function<LocalizedStringBuilder,LocalizedString> builder)

Maps to ProductData.description.

Parameters:

builder - function to build the description value

Returns:

Builder

description

public ProductImportBuilder description(@Nullable
 LocalizedString description)

Maps to ProductData.description.

Parameters:

description - value to be set

Returns:

Builder

categories

public ProductImportBuilder categories(@Nullable
 CategoryKeyReference... categories)

Maps to ProductData.categories. If the referenced Categories do not exist, the state of the ImportOperation will be set to unresolved until the referenced Categories are created.

Parameters:

categories - value to be set

Returns:

Builder

categories

public ProductImportBuilder categories(@Nullable
 List<CategoryKeyReference> categories)

Maps to ProductData.categories. If the referenced Categories do not exist, the state of the ImportOperation will be set to unresolved until the referenced Categories are created.

Parameters:

categories - value to be set

Returns:

Builder

plusCategories

public ProductImportBuilder plusCategories(@Nullable
 CategoryKeyReference... categories)

Maps to ProductData.categories. If the referenced Categories do not exist, the state of the ImportOperation will be set to unresolved until the referenced Categories are created.

Parameters:

categories - value to be set

Returns:

Builder

plusCategories

public ProductImportBuilder plusCategories(Function<CategoryKeyReferenceBuilder,CategoryKeyReferenceBuilder> builder)

Maps to ProductData.categories. If the referenced Categories do not exist, the state of the ImportOperation will be set to unresolved until the referenced Categories are created.

Parameters:

builder - function to build the categories value

Returns:

Builder

withCategories

public ProductImportBuilder withCategories(Function<CategoryKeyReferenceBuilder,CategoryKeyReferenceBuilder> builder)

Maps to ProductData.categories. If the referenced Categories do not exist, the state of the ImportOperation will be set to unresolved until the referenced Categories are created.

Parameters:

builder - function to build the categories value

Returns:

Builder

addCategories

public ProductImportBuilder addCategories(Function<CategoryKeyReferenceBuilder,CategoryKeyReference> builder)

Maps to ProductData.categories. If the referenced Categories do not exist, the state of the ImportOperation will be set to unresolved until the referenced Categories are created.

Parameters:

builder - function to build the categories value

Returns:

Builder

setCategories

public ProductImportBuilder setCategories(Function<CategoryKeyReferenceBuilder,CategoryKeyReference> builder)

Maps to ProductData.categories. If the referenced Categories do not exist, the state of the ImportOperation will be set to unresolved until the referenced Categories are created.

Parameters:

builder - function to build the categories value

Returns:

Builder

attributes

public ProductImportBuilder attributes(@Nullable
 Attribute... attributes)

set values to the attributes

Parameters:

attributes - value to be set

Returns:

Builder

attributes

public ProductImportBuilder attributes(@Nullable
 List<Attribute> attributes)

set value to the attributes

Parameters:

attributes - value to be set

Returns:

Builder

plusAttributes

public ProductImportBuilder plusAttributes(@Nullable
 Attribute... attributes)

add values to the attributes

Parameters:

attributes - value to be set

Returns:

Builder

plusAttributes

public ProductImportBuilder plusAttributes(Function<AttributeBuilder,Builder<? extends Attribute>> builder)

add a value to the attributes using the builder function

Parameters:

builder - function to build the attributes value

Returns:

Builder

withAttributes

public ProductImportBuilder withAttributes(Function<AttributeBuilder,Builder<? extends Attribute>> builder)

set the value to the attributes using the builder function

Parameters:

builder - function to build the attributes value

Returns:

Builder

metaTitle

public ProductImportBuilder metaTitle(Function<LocalizedStringBuilder,LocalizedStringBuilder> builder)

Maps to ProductData.metaTitle.

Parameters:

builder - function to build the metaTitle value

Returns:

Builder

withMetaTitle

public ProductImportBuilder withMetaTitle(Function<LocalizedStringBuilder,LocalizedString> builder)

Maps to ProductData.metaTitle.

Parameters:

builder - function to build the metaTitle value

Returns:

Builder

metaTitle

public ProductImportBuilder metaTitle(@Nullable
 LocalizedString metaTitle)

Maps to ProductData.metaTitle.

Parameters:

metaTitle - value to be set

Returns:

Builder

metaDescription

public ProductImportBuilder metaDescription(Function<LocalizedStringBuilder,LocalizedStringBuilder> builder)

Maps to ProductData.metaDescription.

Parameters:

builder - function to build the metaDescription value

Returns:

Builder

withMetaDescription

public ProductImportBuilder withMetaDescription(Function<LocalizedStringBuilder,LocalizedString> builder)

Maps to ProductData.metaDescription.

Parameters:

builder - function to build the metaDescription value

Returns:

Builder

metaDescription

public ProductImportBuilder metaDescription(@Nullable
 LocalizedString metaDescription)

Maps to ProductData.metaDescription.

Parameters:

metaDescription - value to be set

Returns:

Builder

metaKeywords

public ProductImportBuilder metaKeywords(Function<LocalizedStringBuilder,LocalizedStringBuilder> builder)

Maps to ProductData.metaKeywords.

Parameters:

builder - function to build the metaKeywords value

Returns:

Builder

withMetaKeywords

public ProductImportBuilder withMetaKeywords(Function<LocalizedStringBuilder,LocalizedString> builder)

Maps to ProductData.metaKeywords.

Parameters:

builder - function to build the metaKeywords value

Returns:

Builder

metaKeywords

public ProductImportBuilder metaKeywords(@Nullable
 LocalizedString metaKeywords)

Maps to ProductData.metaKeywords.

Parameters:

metaKeywords - value to be set

Returns:

Builder

taxCategory

public ProductImportBuilder taxCategory(Function<TaxCategoryKeyReferenceBuilder,TaxCategoryKeyReferenceBuilder> builder)

Maps to Product.taxCategory. If the referenced TaxCategory does not exist, the state of the ImportOperation will be set to unresolved until the referenced TaxCategory is created.

Parameters:

builder - function to build the taxCategory value

Returns:

Builder

withTaxCategory

public ProductImportBuilder withTaxCategory(Function<TaxCategoryKeyReferenceBuilder,TaxCategoryKeyReference> builder)

Maps to Product.taxCategory. If the referenced TaxCategory does not exist, the state of the ImportOperation will be set to unresolved until the referenced TaxCategory is created.

Parameters:

builder - function to build the taxCategory value

Returns:

Builder

taxCategory

public ProductImportBuilder taxCategory(@Nullable
 TaxCategoryKeyReference taxCategory)

Maps to Product.taxCategory. If the referenced TaxCategory does not exist, the state of the ImportOperation will be set to unresolved until the referenced TaxCategory is created.

Parameters:

taxCategory - value to be set

Returns:

Builder

searchKeywords

public ProductImportBuilder searchKeywords(Function<SearchKeywordsBuilder,SearchKeywordsBuilder> builder)

Maps to ProductData.searchKeywords.

Parameters:

builder - function to build the searchKeywords value

Returns:

Builder

withSearchKeywords

public ProductImportBuilder withSearchKeywords(Function<SearchKeywordsBuilder,SearchKeywords> builder)

Maps to ProductData.searchKeywords.

Parameters:

builder - function to build the searchKeywords value

Returns:

Builder

searchKeywords

public ProductImportBuilder searchKeywords(@Nullable
 SearchKeywords searchKeywords)

Maps to ProductData.searchKeywords.

Parameters:

searchKeywords - value to be set

Returns:

Builder

state

public ProductImportBuilder state(Function<StateKeyReferenceBuilder,StateKeyReferenceBuilder> builder)

Maps to Product.state. If the referenced State does not exist, the state of the ImportOperation will be set to unresolved until the referenced State is created.

Parameters:

builder - function to build the state value

Returns:

Builder

withState

public ProductImportBuilder withState(Function<StateKeyReferenceBuilder,StateKeyReference> builder)

Maps to Product.state. If the referenced State does not exist, the state of the ImportOperation will be set to unresolved until the referenced State is created.

Parameters:

builder - function to build the state value

Returns:

Builder

state

public ProductImportBuilder state(@Nullable
 StateKeyReference state)

Maps to Product.state. If the referenced State does not exist, the state of the ImportOperation will be set to unresolved until the referenced State is created.

Parameters:

state - value to be set

Returns:

Builder

publish

public ProductImportBuilder publish(@Nullable
 Boolean publish)

Determines the published status and current/staged projection of the Product. For more information, see Managing the published state of Products.

Parameters:

publish - value to be set

Returns:

Builder

priceMode

public ProductImportBuilder priceMode(@Nullable
 ProductPriceModeEnum priceMode)

Maps to Product.priceMode.

Parameters:

priceMode - value to be set

Returns:

Builder

getKey

public String getKey()

User-defined unique identifier. If a Product with this key exists, it is updated with the imported data.

Returns:

key

getName

public LocalizedString getName()

Maps to ProductData.name.

Returns:

name

getProductType

public ProductTypeKeyReference getProductType()

Maps to Product.productType. If the referenced ProductType does not exist, the state of the ImportOperation will be set to unresolved until the referenced ProductType is created.

Returns:

productType

getSlug

public LocalizedString getSlug()

Maps to ProductData.slug.

Returns:

slug

getDescription

@Nullable
public LocalizedString getDescription()

Maps to ProductData.description.

Returns:

description

getCategories

@Nullable
public List<CategoryKeyReference> getCategories()

Maps to ProductData.categories. If the referenced Categories do not exist, the state of the ImportOperation will be set to unresolved until the referenced Categories are created.

Returns:

categories

getAttributes

@Nullable
public List<Attribute> getAttributes()

value of attributes}

Returns:

attributes

getMetaTitle

@Nullable
public LocalizedString getMetaTitle()

Maps to ProductData.metaTitle.

Returns:

metaTitle

getMetaDescription

@Nullable
public LocalizedString getMetaDescription()

Maps to ProductData.metaDescription.

Returns:

metaDescription

getMetaKeywords

@Nullable
public LocalizedString getMetaKeywords()

Maps to ProductData.metaKeywords.

Returns:

metaKeywords

getTaxCategory

@Nullable
public TaxCategoryKeyReference getTaxCategory()

Maps to Product.taxCategory. If the referenced TaxCategory does not exist, the state of the ImportOperation will be set to unresolved until the referenced TaxCategory is created.

Returns:

taxCategory

getSearchKeywords

@Nullable
public SearchKeywords getSearchKeywords()

Maps to ProductData.searchKeywords.

Returns:

searchKeywords

getState

@Nullable
public StateKeyReference getState()

Maps to Product.state. If the referenced State does not exist, the state of the ImportOperation will be set to unresolved until the referenced State is created.

Returns:

state

getPublish

@Nullable
public Boolean getPublish()

Determines the published status and current/staged projection of the Product. For more information, see Managing the published state of Products.

Returns:

publish

getPriceMode

@Nullable
public ProductPriceModeEnum getPriceMode()

Maps to Product.priceMode.

Returns:

priceMode

build

public ProductImport build()

builds ProductImport with checking for non-null required values

Specified by:

build in interface Builder<ProductImport>

Returns:

ProductImport

buildUnchecked

public ProductImport buildUnchecked()

builds ProductImport without checking for non-null required values

Returns:

ProductImport

of

public static ProductImportBuilder of()

factory method for an instance of ProductImportBuilder

Returns:

builder

of

public static ProductImportBuilder of(ProductImport template)

create builder for ProductImport instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder