Package com.commercetools.importapi.models.productvariants

Class ProductVariantPatchBuilder

java.lang.Object

com.commercetools.importapi.models.productvariants.ProductVariantPatchBuilder

All Implemented Interfaces:

Builder<ProductVariantPatch>

public class ProductVariantPatchBuilder
extends Object
implements Builder<ProductVariantPatch>

ProductVariantPatchBuilder Example to create an instance using the builder pattern

     ProductVariantPatch productVariantPatch = ProductVariantPatch.builder()
             .productVariant(productVariantBuilder -> productVariantBuilder)
             .build()
 

Constructor Summary

Constructors

Constructor	Description
ProductVariantPatchBuilder()

Method Summary

Modifier and Type	Method	Description
ProductVariantPatchBuilder	attributes(Attributes attributes)	Maps to ProductVariant.attributes.
ProductVariantPatchBuilder	attributes(Function<AttributesBuilder,AttributesBuilder> builder)	Maps to ProductVariant.attributes.
ProductVariantPatch	build()	builds ProductVariantPatch with checking for non-null required values
ProductVariantPatch	buildUnchecked()	builds ProductVariantPatch without checking for non-null required values
Attributes	getAttributes()	Maps to ProductVariant.attributes.
ProductKeyReference	getProduct()	Reference to the Product that contains the ProductVariant.
ProductVariantKeyReference	getProductVariant()	Reference to the ProductVariant to update.
Boolean	getStaged()	If false, the attribute changes are applied to both current and staged projected representations of the Product.
static ProductVariantPatchBuilder	of()	factory method for an instance of ProductVariantPatchBuilder
static ProductVariantPatchBuilder	of(ProductVariantPatch template)	create builder for ProductVariantPatch instance
ProductVariantPatchBuilder	product(ProductKeyReference product)	Reference to the Product that contains the ProductVariant.
ProductVariantPatchBuilder	product(Function<ProductKeyReferenceBuilder,ProductKeyReferenceBuilder> builder)	Reference to the Product that contains the ProductVariant.
ProductVariantPatchBuilder	productVariant(ProductVariantKeyReference productVariant)	Reference to the ProductVariant to update.
ProductVariantPatchBuilder	productVariant(Function<ProductVariantKeyReferenceBuilder,ProductVariantKeyReferenceBuilder> builder)	Reference to the ProductVariant to update.
ProductVariantPatchBuilder	staged(Boolean staged)	If false, the attribute changes are applied to both current and staged projected representations of the Product.
ProductVariantPatchBuilder	withAttributes(Function<AttributesBuilder,Attributes> builder)	Maps to ProductVariant.attributes.
ProductVariantPatchBuilder	withProduct(Function<ProductKeyReferenceBuilder,ProductKeyReference> builder)	Reference to the Product that contains the ProductVariant.
ProductVariantPatchBuilder	withProductVariant(Function<ProductVariantKeyReferenceBuilder,ProductVariantKeyReference> builder)	Reference to the ProductVariant to update.

Methods inherited from class java.lang.Object

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

Constructor Details

ProductVariantPatchBuilder

public ProductVariantPatchBuilder()

Method Details

productVariant

public ProductVariantPatchBuilder productVariant(Function<ProductVariantKeyReferenceBuilder,ProductVariantKeyReferenceBuilder> builder)

Reference to the ProductVariant to update.

Parameters:

builder - function to build the productVariant value

Returns:

Builder

withProductVariant

public ProductVariantPatchBuilder withProductVariant(Function<ProductVariantKeyReferenceBuilder,ProductVariantKeyReference> builder)

Reference to the ProductVariant to update.

Parameters:

builder - function to build the productVariant value

Returns:

Builder

productVariant

public ProductVariantPatchBuilder productVariant(ProductVariantKeyReference productVariant)

Reference to the ProductVariant to update.

Parameters:

productVariant - value to be set

Returns:

Builder

attributes

public ProductVariantPatchBuilder attributes(Function<AttributesBuilder,AttributesBuilder> builder)

Maps to ProductVariant.attributes.

• The referenced Attribute must be defined in an existing ProductType, or the state of the ImportOperation will be validationFailed.
• Setting the value of a non-required Attribute to null will remove the Attribute.
• Attempting to set a null value to a required Attribute will make the import operation fail with an InvalidOperation error.
• Importing LocalizableTextAttributes or LocalizableTextSetAttributes follows an override pattern, meaning that omitted localized fields will be deleted, new fields will be created, and existing fields will be updated. You can delete localized fields by setting their value to null.

Parameters:

builder - function to build the attributes value

Returns:

Builder

withAttributes

public ProductVariantPatchBuilder withAttributes(Function<AttributesBuilder,Attributes> builder)

Maps to ProductVariant.attributes.

• The referenced Attribute must be defined in an existing ProductType, or the state of the ImportOperation will be validationFailed.
• Setting the value of a non-required Attribute to null will remove the Attribute.
• Attempting to set a null value to a required Attribute will make the import operation fail with an InvalidOperation error.
• Importing LocalizableTextAttributes or LocalizableTextSetAttributes follows an override pattern, meaning that omitted localized fields will be deleted, new fields will be created, and existing fields will be updated. You can delete localized fields by setting their value to null.

Parameters:

builder - function to build the attributes value

Returns:

Builder

attributes

public ProductVariantPatchBuilder attributes(@Nullable
 Attributes attributes)

Maps to ProductVariant.attributes.

• The referenced Attribute must be defined in an existing ProductType, or the state of the ImportOperation will be validationFailed.
• Setting the value of a non-required Attribute to null will remove the Attribute.
• Attempting to set a null value to a required Attribute will make the import operation fail with an InvalidOperation error.
• Importing LocalizableTextAttributes or LocalizableTextSetAttributes follows an override pattern, meaning that omitted localized fields will be deleted, new fields will be created, and existing fields will be updated. You can delete localized fields by setting their value to null.

Parameters:

attributes - value to be set

Returns:

Builder

staged

public ProductVariantPatchBuilder staged(@Nullable
 Boolean staged)

If false, the attribute changes are applied to both current and staged projected representations of the Product.

Parameters:

staged - value to be set

Returns:

Builder

product

public ProductVariantPatchBuilder product(Function<ProductKeyReferenceBuilder,ProductKeyReferenceBuilder> builder)

Reference to the Product that contains the ProductVariant.

We recommend to set this value to minimize concurrency errors. If set, this field is required for every ProductVariantPatch in the ProductVariantPatchRequest.

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

Parameters:

builder - function to build the product value

Returns:

Builder

withProduct

public ProductVariantPatchBuilder withProduct(Function<ProductKeyReferenceBuilder,ProductKeyReference> builder)

Reference to the Product that contains the ProductVariant.

We recommend to set this value to minimize concurrency errors. If set, this field is required for every ProductVariantPatch in the ProductVariantPatchRequest.

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

Parameters:

builder - function to build the product value

Returns:

Builder

product

public ProductVariantPatchBuilder product(@Nullable
 ProductKeyReference product)

Reference to the Product that contains the ProductVariant.

We recommend to set this value to minimize concurrency errors. If set, this field is required for every ProductVariantPatch in the ProductVariantPatchRequest.

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

Parameters:

product - value to be set

Returns:

Builder

getProductVariant

public ProductVariantKeyReference getProductVariant()

Reference to the ProductVariant to update.

Returns:

productVariant

getAttributes

@Nullable
public Attributes getAttributes()

Maps to ProductVariant.attributes.

• The referenced Attribute must be defined in an existing ProductType, or the state of the ImportOperation will be validationFailed.
• Setting the value of a non-required Attribute to null will remove the Attribute.
• Attempting to set a null value to a required Attribute will make the import operation fail with an InvalidOperation error.
• Importing LocalizableTextAttributes or LocalizableTextSetAttributes follows an override pattern, meaning that omitted localized fields will be deleted, new fields will be created, and existing fields will be updated. You can delete localized fields by setting their value to null.

Returns:

attributes

getStaged

@Nullable
public Boolean getStaged()

If false, the attribute changes are applied to both current and staged projected representations of the Product.

Returns:

staged

getProduct

@Nullable
public ProductKeyReference getProduct()

Reference to the Product that contains the ProductVariant.

We recommend to set this value to minimize concurrency errors. If set, this field is required for every ProductVariantPatch in the ProductVariantPatchRequest.

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

Returns:

product

build

public ProductVariantPatch build()

builds ProductVariantPatch with checking for non-null required values

Specified by:

build in interface Builder<ProductVariantPatch>

Returns:

ProductVariantPatch

buildUnchecked

public ProductVariantPatch buildUnchecked()

builds ProductVariantPatch without checking for non-null required values

Returns:

ProductVariantPatch

of

public static ProductVariantPatchBuilder of()

factory method for an instance of ProductVariantPatchBuilder

Returns:

builder

of

public static ProductVariantPatchBuilder of(ProductVariantPatch template)

create builder for ProductVariantPatch instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder