Package com.commercetools.importapi.models.categories

Class CategoryImportBuilder

java.lang.Object

com.commercetools.importapi.models.categories.CategoryImportBuilder

All Implemented Interfaces:

Builder<CategoryImport>

public class CategoryImportBuilder
extends Object
implements Builder<CategoryImport>

CategoryImportBuilder Example to create an instance using the builder pattern

     CategoryImport categoryImport = CategoryImport.builder()
             .key("{key}")
             .name(nameBuilder -> nameBuilder)
             .slug(slugBuilder -> slugBuilder)
             .build()
 

Constructor Summary

Constructors

Constructor	Description
CategoryImportBuilder()

Method Summary

Modifier and Type	Method	Description
CategoryImportBuilder	addAssets(Function<AssetBuilder,Asset> builder)	Maps to Category.assets.
CategoryImportBuilder	assets(Asset... assets)	Maps to Category.assets.
CategoryImportBuilder	assets(List<Asset> assets)	Maps to Category.assets.
CategoryImport	build()	builds CategoryImport with checking for non-null required values
CategoryImport	buildUnchecked()	builds CategoryImport without checking for non-null required values
CategoryImportBuilder	custom(Custom custom)	The custom fields for this Category.
CategoryImportBuilder	custom(Function<CustomBuilder,CustomBuilder> builder)	The custom fields for this Category.
CategoryImportBuilder	description(LocalizedString description)	Maps to Category.description.
CategoryImportBuilder	description(Function<LocalizedStringBuilder,LocalizedStringBuilder> builder)	Maps to Category.description.
CategoryImportBuilder	externalId(String externalId)	Maps to Category.externalId.
List<Asset>	getAssets()	Maps to Category.assets.
Custom	getCustom()	The custom fields for this Category.
LocalizedString	getDescription()	Maps to Category.description.
String	getExternalId()	Maps to Category.externalId.
String	getKey()	User-defined unique identifier.
LocalizedString	getMetaDescription()	Maps to Category.metaDescription.
LocalizedString	getMetaKeywords()	Maps to Category.metaKeywords.
LocalizedString	getMetaTitle()	Maps to Category.metaTitle.
LocalizedString	getName()	Maps to Category.name.
String	getOrderHint()	Maps to Category.orderHint.
CategoryKeyReference	getParent()	Maps to Category.parent.
LocalizedString	getSlug()	Maps to Category.slug.
CategoryImportBuilder	key(String key)	User-defined unique identifier.
CategoryImportBuilder	metaDescription(LocalizedString metaDescription)	Maps to Category.metaDescription.
CategoryImportBuilder	metaDescription(Function<LocalizedStringBuilder,LocalizedStringBuilder> builder)	Maps to Category.metaDescription.
CategoryImportBuilder	metaKeywords(LocalizedString metaKeywords)	Maps to Category.metaKeywords.
CategoryImportBuilder	metaKeywords(Function<LocalizedStringBuilder,LocalizedStringBuilder> builder)	Maps to Category.metaKeywords.
CategoryImportBuilder	metaTitle(LocalizedString metaTitle)	Maps to Category.metaTitle.
CategoryImportBuilder	metaTitle(Function<LocalizedStringBuilder,LocalizedStringBuilder> builder)	Maps to Category.metaTitle.
CategoryImportBuilder	name(LocalizedString name)	Maps to Category.name.
CategoryImportBuilder	name(Function<LocalizedStringBuilder,LocalizedStringBuilder> builder)	Maps to Category.name.
static CategoryImportBuilder	of()	factory method for an instance of CategoryImportBuilder
static CategoryImportBuilder	of(CategoryImport template)	create builder for CategoryImport instance
CategoryImportBuilder	orderHint(String orderHint)	Maps to Category.orderHint.
CategoryImportBuilder	parent(CategoryKeyReference parent)	Maps to Category.parent.
CategoryImportBuilder	parent(Function<CategoryKeyReferenceBuilder,CategoryKeyReferenceBuilder> builder)	Maps to Category.parent.
CategoryImportBuilder	plusAssets(Asset... assets)	Maps to Category.assets.
CategoryImportBuilder	plusAssets(Function<AssetBuilder,AssetBuilder> builder)	Maps to Category.assets.
CategoryImportBuilder	setAssets(Function<AssetBuilder,Asset> builder)	Maps to Category.assets.
CategoryImportBuilder	slug(LocalizedString slug)	Maps to Category.slug.
CategoryImportBuilder	slug(Function<LocalizedStringBuilder,LocalizedStringBuilder> builder)	Maps to Category.slug.
CategoryImportBuilder	withAssets(Function<AssetBuilder,AssetBuilder> builder)	Maps to Category.assets.
CategoryImportBuilder	withCustom(Function<CustomBuilder,Custom> builder)	The custom fields for this Category.
CategoryImportBuilder	withDescription(Function<LocalizedStringBuilder,LocalizedString> builder)	Maps to Category.description.
CategoryImportBuilder	withMetaDescription(Function<LocalizedStringBuilder,LocalizedString> builder)	Maps to Category.metaDescription.
CategoryImportBuilder	withMetaKeywords(Function<LocalizedStringBuilder,LocalizedString> builder)	Maps to Category.metaKeywords.
CategoryImportBuilder	withMetaTitle(Function<LocalizedStringBuilder,LocalizedString> builder)	Maps to Category.metaTitle.
CategoryImportBuilder	withName(Function<LocalizedStringBuilder,LocalizedString> builder)	Maps to Category.name.
CategoryImportBuilder	withParent(Function<CategoryKeyReferenceBuilder,CategoryKeyReference> builder)	Maps to Category.parent.
CategoryImportBuilder	withSlug(Function<LocalizedStringBuilder,LocalizedString> builder)	Maps to Category.slug.

Methods inherited from class java.lang.Object

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

Constructor Details

CategoryImportBuilder

public CategoryImportBuilder()

Method Details

key

public CategoryImportBuilder key(String key)

User-defined unique identifier. If a Category with this key exists, it will be updated with the imported data.

Parameters:

key - value to be set

Returns:

Builder

name

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

Maps to Category.name.

Parameters:

builder - function to build the name value

Returns:

Builder

withName

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

Maps to Category.name.

Parameters:

builder - function to build the name value

Returns:

Builder

name

public CategoryImportBuilder name(LocalizedString name)

Maps to Category.name.

Parameters:

name - value to be set

Returns:

Builder

slug

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

Maps to Category.slug. Must match the pattern [-a-zA-Z0-9_]{2,256}.

Parameters:

builder - function to build the slug value

Returns:

Builder

withSlug

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

Maps to Category.slug. Must match the pattern [-a-zA-Z0-9_]{2,256}.

Parameters:

builder - function to build the slug value

Returns:

Builder

slug

public CategoryImportBuilder slug(LocalizedString slug)

Maps to Category.slug. Must match the pattern [-a-zA-Z0-9_]{2,256}.

Parameters:

slug - value to be set

Returns:

Builder

description

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

Maps to Category.description.

Parameters:

builder - function to build the description value

Returns:

Builder

withDescription

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

Maps to Category.description.

Parameters:

builder - function to build the description value

Returns:

Builder

description

public CategoryImportBuilder description(@Nullable
 LocalizedString description)

Maps to Category.description.

Parameters:

description - value to be set

Returns:

Builder

parent

public CategoryImportBuilder parent(Function<CategoryKeyReferenceBuilder,CategoryKeyReferenceBuilder> builder)

Maps to Category.parent. The Reference to the parent Category with which the Category is associated. If referenced Category does not exist, the state of the ImportOperation will be set to unresolved until the necessary Category is created.

Parameters:

builder - function to build the parent value

Returns:

Builder

withParent

public CategoryImportBuilder withParent(Function<CategoryKeyReferenceBuilder,CategoryKeyReference> builder)

Maps to Category.parent. The Reference to the parent Category with which the Category is associated. If referenced Category does not exist, the state of the ImportOperation will be set to unresolved until the necessary Category is created.

Parameters:

builder - function to build the parent value

Returns:

Builder

parent

public CategoryImportBuilder parent(@Nullable
 CategoryKeyReference parent)

Maps to Category.parent. The Reference to the parent Category with which the Category is associated. If referenced Category does not exist, the state of the ImportOperation will be set to unresolved until the necessary Category is created.

Parameters:

parent - value to be set

Returns:

Builder

orderHint

public CategoryImportBuilder orderHint(@Nullable
 String orderHint)

Maps to Category.orderHint.

Parameters:

orderHint - value to be set

Returns:

Builder

externalId

public CategoryImportBuilder externalId(@Nullable
 String externalId)

Maps to Category.externalId.

Parameters:

externalId - value to be set

Returns:

Builder

metaTitle

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

Maps to Category.metaTitle.

Parameters:

builder - function to build the metaTitle value

Returns:

Builder

withMetaTitle

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

Maps to Category.metaTitle.

Parameters:

builder - function to build the metaTitle value

Returns:

Builder

metaTitle

public CategoryImportBuilder metaTitle(@Nullable
 LocalizedString metaTitle)

Maps to Category.metaTitle.

Parameters:

metaTitle - value to be set

Returns:

Builder

metaDescription

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

Maps to Category.metaDescription.

Parameters:

builder - function to build the metaDescription value

Returns:

Builder

withMetaDescription

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

Maps to Category.metaDescription.

Parameters:

builder - function to build the metaDescription value

Returns:

Builder

metaDescription

public CategoryImportBuilder metaDescription(@Nullable
 LocalizedString metaDescription)

Maps to Category.metaDescription.

Parameters:

metaDescription - value to be set

Returns:

Builder

metaKeywords

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

Maps to Category.metaKeywords.

Parameters:

builder - function to build the metaKeywords value

Returns:

Builder

withMetaKeywords

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

Maps to Category.metaKeywords.

Parameters:

builder - function to build the metaKeywords value

Returns:

Builder

metaKeywords

public CategoryImportBuilder metaKeywords(@Nullable
 LocalizedString metaKeywords)

Maps to Category.metaKeywords.

Parameters:

metaKeywords - value to be set

Returns:

Builder

assets

public CategoryImportBuilder assets(@Nullable
 Asset... assets)

Maps to Category.assets.

Parameters:

assets - value to be set

Returns:

Builder

assets

public CategoryImportBuilder assets(@Nullable
 List<Asset> assets)

Maps to Category.assets.

Parameters:

assets - value to be set

Returns:

Builder

plusAssets

public CategoryImportBuilder plusAssets(@Nullable
 Asset... assets)

Maps to Category.assets.

Parameters:

assets - value to be set

Returns:

Builder

plusAssets

public CategoryImportBuilder plusAssets(Function<AssetBuilder,AssetBuilder> builder)

Maps to Category.assets.

Parameters:

builder - function to build the assets value

Returns:

Builder

withAssets

public CategoryImportBuilder withAssets(Function<AssetBuilder,AssetBuilder> builder)

Maps to Category.assets.

Parameters:

builder - function to build the assets value

Returns:

Builder

addAssets

public CategoryImportBuilder addAssets(Function<AssetBuilder,Asset> builder)

Maps to Category.assets.

Parameters:

builder - function to build the assets value

Returns:

Builder

setAssets

public CategoryImportBuilder setAssets(Function<AssetBuilder,Asset> builder)

Maps to Category.assets.

Parameters:

builder - function to build the assets value

Returns:

Builder

custom

public CategoryImportBuilder custom(Function<CustomBuilder,CustomBuilder> builder)

The custom fields for this Category.

Parameters:

builder - function to build the custom value

Returns:

Builder

withCustom

public CategoryImportBuilder withCustom(Function<CustomBuilder,Custom> builder)

The custom fields for this Category.

Parameters:

builder - function to build the custom value

Returns:

Builder

custom

public CategoryImportBuilder custom(@Nullable
 Custom custom)

The custom fields for this Category.

Parameters:

custom - value to be set

Returns:

Builder

getKey

public String getKey()

User-defined unique identifier. If a Category with this key exists, it will be updated with the imported data.

Returns:

key

getName

public LocalizedString getName()

Maps to Category.name.

Returns:

name

getSlug

public LocalizedString getSlug()

Maps to Category.slug. Must match the pattern [-a-zA-Z0-9_]{2,256}.

Returns:

slug

getDescription

@Nullable
public LocalizedString getDescription()

Maps to Category.description.

Returns:

description

getParent

@Nullable
public CategoryKeyReference getParent()

Maps to Category.parent. The Reference to the parent Category with which the Category is associated. If referenced Category does not exist, the state of the ImportOperation will be set to unresolved until the necessary Category is created.

Returns:

parent

getOrderHint

@Nullable
public String getOrderHint()

Maps to Category.orderHint.

Returns:

orderHint

getExternalId

@Nullable
public String getExternalId()

Maps to Category.externalId.

Returns:

externalId

getMetaTitle

@Nullable
public LocalizedString getMetaTitle()

Maps to Category.metaTitle.

Returns:

metaTitle

getMetaDescription

@Nullable
public LocalizedString getMetaDescription()

Maps to Category.metaDescription.

Returns:

metaDescription

getMetaKeywords

@Nullable
public LocalizedString getMetaKeywords()

Maps to Category.metaKeywords.

Returns:

metaKeywords

getAssets

@Nullable
public List<Asset> getAssets()

Maps to Category.assets.

Returns:

assets

getCustom

@Nullable
public Custom getCustom()

The custom fields for this Category.

Returns:

custom

build

public CategoryImport build()

builds CategoryImport with checking for non-null required values

Specified by:

build in interface Builder<CategoryImport>

Returns:

CategoryImport

buildUnchecked

public CategoryImport buildUnchecked()

builds CategoryImport without checking for non-null required values

Returns:

CategoryImport

of

public static CategoryImportBuilder of()

factory method for an instance of CategoryImportBuilder

Returns:

builder

of

public static CategoryImportBuilder of(CategoryImport template)

create builder for CategoryImport instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder