Package com.commercetools.api.models.variant

Class VariantProjectionBuilder

java.lang.Object

com.commercetools.api.models.variant.VariantProjectionBuilder

All Implemented Interfaces:

Builder<VariantProjection>

public class VariantProjectionBuilder
extends Object
implements Builder<VariantProjection>

VariantProjectionBuilder Example to create an instance using the builder pattern

     VariantProjection variantProjection = VariantProjection.builder()
             .id("{id}")
             .version(0.3)
             .createdAt(ZonedDateTime.parse("2022-01-01T12:00:00.301Z"))
             .staged(true)
             .variantId(0.3)
             .product(productBuilder -> productBuilder)
             .name(nameBuilder -> nameBuilder)
             .slug(slugBuilder -> slugBuilder)
             .plusImages(imagesBuilder -> imagesBuilder)
             .plusAssets(assetsBuilder -> assetsBuilder)
             .plusAttributes(attributesBuilder -> attributesBuilder)
             .default(true)
             .build()
 

Constructor Summary

Constructors

Constructor	Description
VariantProjectionBuilder()

Method Summary

Modifier and Type	Method	Description
VariantProjectionBuilder	_default(Boolean _default)	true if this Variant is the default Variant of its Product (see Product.defaultVariant).
VariantProjectionBuilder	addAssets(Function<AssetBuilder,Asset> builder)	Assets of the Variant.
VariantProjectionBuilder	addAttributes(Function<AttributeBuilder,Attribute> builder)	Attributes of the Variant, including product-level Attributes merged at projection time.
VariantProjectionBuilder	addImages(Function<ImageBuilder,Image> builder)	Images of the Variant.
VariantProjectionBuilder	assets(Asset... assets)	Assets of the Variant.
VariantProjectionBuilder	assets(List<Asset> assets)	Assets of the Variant.
VariantProjectionBuilder	attributes(Attribute... attributes)	Attributes of the Variant, including product-level Attributes merged at projection time.
VariantProjectionBuilder	attributes(List<Attribute> attributes)	Attributes of the Variant, including product-level Attributes merged at projection time.
VariantProjection	build()	builds VariantProjection with checking for non-null required values
VariantProjection	buildUnchecked()	builds VariantProjection without checking for non-null required values
VariantProjectionBuilder	createdAt(ZonedDateTime createdAt)	Date and time (UTC) the Variant Projection was initially created.
VariantProjectionBuilder	description(LocalizedString description)	Description of the parent Product.
VariantProjectionBuilder	description(Function<LocalizedStringBuilder,LocalizedStringBuilder> builder)	Description of the parent Product.
List<Asset>	getAssets()	Assets of the Variant.
List<Attribute>	getAttributes()	Attributes of the Variant, including product-level Attributes merged at projection time.
ZonedDateTime	getCreatedAt()	Date and time (UTC) the Variant Projection was initially created.
Boolean	getDefault()	true if this Variant is the default Variant of its Product (see Product.defaultVariant).
LocalizedString	getDescription()	Description of the parent Product.
String	getId()	Unique identifier of the Variant within its parent Product.
List<Image>	getImages()	Images of the Variant.
String	getKey()	User-defined unique identifier of the Variant.
LocalizedString	getName()	Name of the parent Product.
Price	getPrice()	The selected price based on the price selection query parameters.
ProductReference	getProduct()	Reference to the parent Product.
String	getSku()	SKU of the Variant.
LocalizedString	getSlug()	Slug of the parent Product.
Boolean	getStaged()	true for the staged (draft) projection, false for the current (published) projection.
Integer	getVariantId()	The id of the Variant.
Long	getVersion()	Current version of the Variant Projection.
VariantProjectionBuilder	id(String id)	Unique identifier of the Variant within its parent Product.
VariantProjectionBuilder	images(Image... images)	Images of the Variant.
VariantProjectionBuilder	images(List<Image> images)	Images of the Variant.
VariantProjectionBuilder	key(String key)	User-defined unique identifier of the Variant.
VariantProjectionBuilder	name(LocalizedString name)	Name of the parent Product.
VariantProjectionBuilder	name(Function<LocalizedStringBuilder,LocalizedStringBuilder> builder)	Name of the parent Product.
static VariantProjectionBuilder	of()	factory method for an instance of VariantProjectionBuilder
static VariantProjectionBuilder	of(VariantProjection template)	create builder for VariantProjection instance
VariantProjectionBuilder	plusAssets(Asset... assets)	Assets of the Variant.
VariantProjectionBuilder	plusAssets(Function<AssetBuilder,AssetBuilder> builder)	Assets of the Variant.
VariantProjectionBuilder	plusAttributes(Attribute... attributes)	Attributes of the Variant, including product-level Attributes merged at projection time.
VariantProjectionBuilder	plusAttributes(Function<AttributeBuilder,AttributeBuilder> builder)	Attributes of the Variant, including product-level Attributes merged at projection time.
VariantProjectionBuilder	plusImages(Image... images)	Images of the Variant.
VariantProjectionBuilder	plusImages(Function<ImageBuilder,ImageBuilder> builder)	Images of the Variant.
VariantProjectionBuilder	price(Price price)	The selected price based on the price selection query parameters.
VariantProjectionBuilder	price(Function<PriceBuilder,PriceBuilder> builder)	The selected price based on the price selection query parameters.
VariantProjectionBuilder	product(ProductReference product)	Reference to the parent Product.
VariantProjectionBuilder	product(Function<ProductReferenceBuilder,ProductReferenceBuilder> builder)	Reference to the parent Product.
VariantProjectionBuilder	setAssets(Function<AssetBuilder,Asset> builder)	Assets of the Variant.
VariantProjectionBuilder	setAttributes(Function<AttributeBuilder,Attribute> builder)	Attributes of the Variant, including product-level Attributes merged at projection time.
VariantProjectionBuilder	setImages(Function<ImageBuilder,Image> builder)	Images of the Variant.
VariantProjectionBuilder	sku(String sku)	SKU of the Variant.
VariantProjectionBuilder	slug(LocalizedString slug)	Slug of the parent Product.
VariantProjectionBuilder	slug(Function<LocalizedStringBuilder,LocalizedStringBuilder> builder)	Slug of the parent Product.
VariantProjectionBuilder	staged(Boolean staged)	true for the staged (draft) projection, false for the current (published) projection.
VariantProjectionBuilder	variantId(Integer variantId)	The id of the Variant.
VariantProjectionBuilder	version(Long version)	Current version of the Variant Projection.
VariantProjectionBuilder	withAssets(Function<AssetBuilder,AssetBuilder> builder)	Assets of the Variant.
VariantProjectionBuilder	withAttributes(Function<AttributeBuilder,AttributeBuilder> builder)	Attributes of the Variant, including product-level Attributes merged at projection time.
VariantProjectionBuilder	withDescription(Function<LocalizedStringBuilder,LocalizedString> builder)	Description of the parent Product.
VariantProjectionBuilder	withImages(Function<ImageBuilder,ImageBuilder> builder)	Images of the Variant.
VariantProjectionBuilder	withName(Function<LocalizedStringBuilder,LocalizedString> builder)	Name of the parent Product.
VariantProjectionBuilder	withPrice(Function<PriceBuilder,Price> builder)	The selected price based on the price selection query parameters.
VariantProjectionBuilder	withProduct(Function<ProductReferenceBuilder,ProductReference> builder)	Reference to the parent Product.
VariantProjectionBuilder	withSlug(Function<LocalizedStringBuilder,LocalizedString> builder)	Slug of the parent Product.

Methods inherited from class java.lang.Object

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

Constructor Details

VariantProjectionBuilder

public VariantProjectionBuilder()

Method Details

id

public VariantProjectionBuilder id(String id)

Unique identifier of the Variant within its parent Product.

Parameters:

id - value to be set

Returns:

Builder

version

public VariantProjectionBuilder version(Long version)

Current version of the Variant Projection.

Parameters:

version - value to be set

Returns:

Builder

createdAt

public VariantProjectionBuilder createdAt(ZonedDateTime createdAt)

Date and time (UTC) the Variant Projection was initially created.

Parameters:

createdAt - value to be set

Returns:

Builder

staged

public VariantProjectionBuilder staged(Boolean staged)

true for the staged (draft) projection, false for the current (published) projection.

Parameters:

staged - value to be set

Returns:

Builder

variantId

public VariantProjectionBuilder variantId(Integer variantId)

The id of the Variant.

Parameters:

variantId - value to be set

Returns:

Builder

product

public VariantProjectionBuilder product(Function<ProductReferenceBuilder,ProductReferenceBuilder> builder)

Reference to the parent Product.

Parameters:

builder - function to build the product value

Returns:

Builder

withProduct

public VariantProjectionBuilder withProduct(Function<ProductReferenceBuilder,ProductReference> builder)

Reference to the parent Product.

Parameters:

builder - function to build the product value

Returns:

Builder

product

public VariantProjectionBuilder product(ProductReference product)

Reference to the parent Product.

Parameters:

product - value to be set

Returns:

Builder

name

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

Name of the parent Product.

Parameters:

builder - function to build the name value

Returns:

Builder

withName

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

Name of the parent Product.

Parameters:

builder - function to build the name value

Returns:

Builder

name

public VariantProjectionBuilder name(LocalizedString name)

Name of the parent Product.

Parameters:

name - value to be set

Returns:

Builder

slug

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

Slug of the parent Product.

Parameters:

builder - function to build the slug value

Returns:

Builder

withSlug

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

Slug of the parent Product.

Parameters:

builder - function to build the slug value

Returns:

Builder

slug

public VariantProjectionBuilder slug(LocalizedString slug)

Slug of the parent Product.

Parameters:

slug - value to be set

Returns:

Builder

description

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

Description of the parent Product.

Parameters:

builder - function to build the description value

Returns:

Builder

withDescription

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

Description of the parent Product.

Parameters:

builder - function to build the description value

Returns:

Builder

description

public VariantProjectionBuilder description(@Nullable
 LocalizedString description)

Description of the parent Product.

Parameters:

description - value to be set

Returns:

Builder

key

public VariantProjectionBuilder key(@Nullable
 String key)

User-defined unique identifier of the Variant.

Parameters:

key - value to be set

Returns:

Builder

sku

public VariantProjectionBuilder sku(@Nullable
 String sku)

SKU of the Variant.

Parameters:

sku - value to be set

Returns:

Builder

images

public VariantProjectionBuilder images(Image... images)

Images of the Variant.

Parameters:

images - value to be set

Returns:

Builder

images

public VariantProjectionBuilder images(List<Image> images)

Images of the Variant.

Parameters:

images - value to be set

Returns:

Builder

plusImages

public VariantProjectionBuilder plusImages(Image... images)

Images of the Variant.

Parameters:

images - value to be set

Returns:

Builder

plusImages

public VariantProjectionBuilder plusImages(Function<ImageBuilder,ImageBuilder> builder)

Images of the Variant.

Parameters:

builder - function to build the images value

Returns:

Builder

withImages

public VariantProjectionBuilder withImages(Function<ImageBuilder,ImageBuilder> builder)

Images of the Variant.

Parameters:

builder - function to build the images value

Returns:

Builder

addImages

public VariantProjectionBuilder addImages(Function<ImageBuilder,Image> builder)

Images of the Variant.

Parameters:

builder - function to build the images value

Returns:

Builder

setImages

public VariantProjectionBuilder setImages(Function<ImageBuilder,Image> builder)

Images of the Variant.

Parameters:

builder - function to build the images value

Returns:

Builder

assets

public VariantProjectionBuilder assets(Asset... assets)

Assets of the Variant.

Parameters:

assets - value to be set

Returns:

Builder

assets

public VariantProjectionBuilder assets(List<Asset> assets)

Assets of the Variant.

Parameters:

assets - value to be set

Returns:

Builder

plusAssets

public VariantProjectionBuilder plusAssets(Asset... assets)

Assets of the Variant.

Parameters:

assets - value to be set

Returns:

Builder

plusAssets

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

Assets of the Variant.

Parameters:

builder - function to build the assets value

Returns:

Builder

withAssets

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

Assets of the Variant.

Parameters:

builder - function to build the assets value

Returns:

Builder

addAssets

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

Assets of the Variant.

Parameters:

builder - function to build the assets value

Returns:

Builder

setAssets

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

Assets of the Variant.

Parameters:

builder - function to build the assets value

Returns:

Builder

attributes

public VariantProjectionBuilder attributes(Attribute... attributes)

Attributes of the Variant, including product-level Attributes merged at projection time.

Parameters:

attributes - value to be set

Returns:

Builder

attributes

public VariantProjectionBuilder attributes(List<Attribute> attributes)

Attributes of the Variant, including product-level Attributes merged at projection time.

Parameters:

attributes - value to be set

Returns:

Builder

plusAttributes

public VariantProjectionBuilder plusAttributes(Attribute... attributes)

Attributes of the Variant, including product-level Attributes merged at projection time.

Parameters:

attributes - value to be set

Returns:

Builder

plusAttributes

public VariantProjectionBuilder plusAttributes(Function<AttributeBuilder,AttributeBuilder> builder)

Attributes of the Variant, including product-level Attributes merged at projection time.

Parameters:

builder - function to build the attributes value

Returns:

Builder

withAttributes

public VariantProjectionBuilder withAttributes(Function<AttributeBuilder,AttributeBuilder> builder)

Attributes of the Variant, including product-level Attributes merged at projection time.

Parameters:

builder - function to build the attributes value

Returns:

Builder

addAttributes

public VariantProjectionBuilder addAttributes(Function<AttributeBuilder,Attribute> builder)

Attributes of the Variant, including product-level Attributes merged at projection time.

Parameters:

builder - function to build the attributes value

Returns:

Builder

setAttributes

public VariantProjectionBuilder setAttributes(Function<AttributeBuilder,Attribute> builder)

Attributes of the Variant, including product-level Attributes merged at projection time.

Parameters:

builder - function to build the attributes value

Returns:

Builder

price

public VariantProjectionBuilder price(Function<PriceBuilder,PriceBuilder> builder)

The selected price based on the price selection query parameters. Only present when price selection parameters are provided.

Parameters:

builder - function to build the price value

Returns:

Builder

withPrice

public VariantProjectionBuilder withPrice(Function<PriceBuilder,Price> builder)

The selected price based on the price selection query parameters. Only present when price selection parameters are provided.

Parameters:

builder - function to build the price value

Returns:

Builder

price

public VariantProjectionBuilder price(@Nullable
 Price price)

The selected price based on the price selection query parameters. Only present when price selection parameters are provided.

Parameters:

price - value to be set

Returns:

Builder

_default

public VariantProjectionBuilder _default(Boolean _default)

true if this Variant is the default Variant of its Product (see Product.defaultVariant). false otherwise.

Parameters:

_default - value to be set

Returns:

Builder

getId

public String getId()

Unique identifier of the Variant within its parent Product.

Returns:

id

getVersion

public Long getVersion()

Current version of the Variant Projection.

Returns:

version

getCreatedAt

public ZonedDateTime getCreatedAt()

Date and time (UTC) the Variant Projection was initially created.

Returns:

createdAt

getStaged

public Boolean getStaged()

true for the staged (draft) projection, false for the current (published) projection.

Returns:

staged

getVariantId

public Integer getVariantId()

The id of the Variant.

Returns:

variantId

getProduct

public ProductReference getProduct()

Reference to the parent Product.

Returns:

product

getName

public LocalizedString getName()

Name of the parent Product.

Returns:

name

getSlug

public LocalizedString getSlug()

Slug of the parent Product.

Returns:

slug

getDescription

@Nullable
public LocalizedString getDescription()

Description of the parent Product.

Returns:

description

getKey

@Nullable
public String getKey()

User-defined unique identifier of the Variant.

Returns:

key

getSku

@Nullable
public String getSku()

SKU of the Variant.

Returns:

sku

getImages

public List<Image> getImages()

Images of the Variant.

Returns:

images

getAssets

public List<Asset> getAssets()

Assets of the Variant.

Returns:

assets

getAttributes

public List<Attribute> getAttributes()

Attributes of the Variant, including product-level Attributes merged at projection time.

Returns:

attributes

getPrice

@Nullable
public Price getPrice()

The selected price based on the price selection query parameters. Only present when price selection parameters are provided.

Returns:

price

getDefault

public Boolean getDefault()

true if this Variant is the default Variant of its Product (see Product.defaultVariant). false otherwise.

Returns:

default

build

public VariantProjection build()

builds VariantProjection with checking for non-null required values

Specified by:

build in interface Builder<VariantProjection>

Returns:

VariantProjection

buildUnchecked

public VariantProjection buildUnchecked()

builds VariantProjection without checking for non-null required values

Returns:

VariantProjection

of

public static VariantProjectionBuilder of()

factory method for an instance of VariantProjectionBuilder

Returns:

builder

of

public static VariantProjectionBuilder of(VariantProjection template)

create builder for VariantProjection instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder