Package com.commercetools.api.models.product

Interface ProductSetProductAttributeAction

All Superinterfaces:

ProductUpdateAction, ResourceUpdateAction<ProductUpdateAction>

public interface ProductSetProductAttributeAction
extends ProductUpdateAction

ProductSetProductAttributeAction Example to create an instance using the builder pattern

     ProductSetProductAttributeAction productSetProductAttributeAction = ProductSetProductAttributeAction.builder()
             .name("{name}")
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SET_PRODUCT_ATTRIBUTE	discriminator value for ProductSetProductAttributeAction

Method Summary

Modifier and Type	Method	Description
static ProductSetProductAttributeActionBuilder	builder()	builder factory method for ProductSetProductAttributeAction
static ProductSetProductAttributeActionBuilder	builder(ProductSetProductAttributeAction template)	create builder for ProductSetProductAttributeAction instance
ProductSetProductAttributeAction	copyDeep()
static ProductSetProductAttributeAction	deepCopy(ProductSetProductAttributeAction template)	factory method to create a deep copy of ProductSetProductAttributeAction
@NotNull String	getName()	Name of the Product Attribute to set.
Boolean	getStaged()	If true, only the staged Attribute is set.
Object	getValue()	Value to set for the Attribute.
static ProductSetProductAttributeAction	of()	factory method
static ProductSetProductAttributeAction	of(ProductSetProductAttributeAction template)	factory method to create a shallow copy ProductSetProductAttributeAction
void	setName(String name)	Name of the Product Attribute to set.
void	setStaged(Boolean staged)	If true, only the staged Attribute is set.
void	setValue(Object value)	Value to set for the Attribute.
static com.fasterxml.jackson.core.type.TypeReference<ProductSetProductAttributeAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withProductSetProductAttributeAction(Function<ProductSetProductAttributeAction,T> helper)	accessor map function

Methods inherited from interface com.commercetools.api.models.product.ProductUpdateAction

getAction, withProductUpdateAction

Methods inherited from interface com.commercetools.api.models.ResourceUpdateAction

get

Field Details

SET_PRODUCT_ATTRIBUTE

static final String SET_PRODUCT_ATTRIBUTE

discriminator value for ProductSetProductAttributeAction

See Also:

• Constant Field Values

Method Details

getName

@NotNull
@NotNull String getName()

Name of the Product Attribute to set.

Returns:

name

getValue

Object getValue()

Value to set for the Attribute. If empty, any existing value will be removed.

The AttributeType determines the format of the Attribute value to be provided:

• For Enum Type and Localized Enum Type, use the key of the Plain Enum Value or Localized Enum Value object or the complete object as value.
• For Localizable Text Type, use the LocalizedString object as value.
• For Money Type Attributes, use the Money object as value.
• For Set Type Attributes, use the entire set object as value.
• For Nested Type Attributes, use the list of values of all Attributes of the nested Product as value.
• For Reference Type Attributes, use the Reference object as value.

Returns:

value

getStaged

Boolean getStaged()

If true, only the staged Attribute is set. If false, both the current and staged Attributes are set.

Returns:

staged

setName

void setName(String name)

Name of the Product Attribute to set.

Parameters:

name - value to be set

setValue

void setValue(Object value)

Value to set for the Attribute. If empty, any existing value will be removed.

The AttributeType determines the format of the Attribute value to be provided:

• For Enum Type and Localized Enum Type, use the key of the Plain Enum Value or Localized Enum Value object or the complete object as value.
• For Localizable Text Type, use the LocalizedString object as value.
• For Money Type Attributes, use the Money object as value.
• For Set Type Attributes, use the entire set object as value.
• For Nested Type Attributes, use the list of values of all Attributes of the nested Product as value.
• For Reference Type Attributes, use the Reference object as value.

Parameters:

value - value to be set

setStaged

void setStaged(Boolean staged)

If true, only the staged Attribute is set. If false, both the current and staged Attributes are set.

Parameters:

staged - value to be set

of

static ProductSetProductAttributeAction of()

factory method

Returns:

instance of ProductSetProductAttributeAction

of

static ProductSetProductAttributeAction of(ProductSetProductAttributeAction template)

factory method to create a shallow copy ProductSetProductAttributeAction

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

ProductSetProductAttributeAction copyDeep()

Specified by:

copyDeep in interface ProductUpdateAction

deepCopy

@Nullable
static ProductSetProductAttributeAction deepCopy(@Nullable
 ProductSetProductAttributeAction template)

factory method to create a deep copy of ProductSetProductAttributeAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static ProductSetProductAttributeActionBuilder builder()

builder factory method for ProductSetProductAttributeAction

Returns:

builder

builder

static ProductSetProductAttributeActionBuilder builder(ProductSetProductAttributeAction template)

create builder for ProductSetProductAttributeAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withProductSetProductAttributeAction

default <T> T withProductSetProductAttributeAction(Function<ProductSetProductAttributeAction,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<ProductSetProductAttributeAction> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference