Package com.commercetools.api.models.variant

Interface VariantSetAttributeAction

All Superinterfaces:

VariantUpdateAction

public interface VariantSetAttributeAction
extends VariantUpdateAction

Set a specific Variant attribute.

Example to create an instance using the builder pattern

     VariantSetAttributeAction variantSetAttributeAction = VariantSetAttributeAction.builder()
             .name("{name}")
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SET_ATTRIBUTE	discriminator value for VariantSetAttributeAction

Method Summary

Modifier and Type	Method	Description
static VariantSetAttributeActionBuilder	builder()	builder factory method for VariantSetAttributeAction
static VariantSetAttributeActionBuilder	builder(VariantSetAttributeAction template)	create builder for VariantSetAttributeAction instance
VariantSetAttributeAction	copyDeep()
static VariantSetAttributeAction	deepCopy(VariantSetAttributeAction template)	factory method to create a deep copy of VariantSetAttributeAction
@NotNull String	getName()	Name of the Attribute to set.
Boolean	getStaged()	If true, only the staged Attribute is set.
Object	getValue()	Value to set for the Attribute.
static VariantSetAttributeAction	of()	factory method
static VariantSetAttributeAction	of(VariantSetAttributeAction template)	factory method to create a shallow copy VariantSetAttributeAction
void	setName(String name)	Name of the 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 tools.jackson.core.type.TypeReference<VariantSetAttributeAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withVariantSetAttributeAction(Function<VariantSetAttributeAction,T> helper)	accessor map function

Methods inherited from interface com.commercetools.api.models.variant.VariantUpdateAction

getAction, withVariantUpdateAction

Field Details

SET_ATTRIBUTE

static final String SET_ATTRIBUTE

discriminator value for VariantSetAttributeAction

See Also:

• Constant Field Values

Method Details

getName

@NotNull
@NotNull String getName()

Name of the 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 Variant 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 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 Variant 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 VariantSetAttributeAction of()

factory method

Returns:

instance of VariantSetAttributeAction

of

static VariantSetAttributeAction of(VariantSetAttributeAction template)

factory method to create a shallow copy VariantSetAttributeAction

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

VariantSetAttributeAction copyDeep()

Specified by:

copyDeep in interface VariantUpdateAction

deepCopy

@Nullable
static VariantSetAttributeAction deepCopy(@Nullable
 VariantSetAttributeAction template)

factory method to create a deep copy of VariantSetAttributeAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static VariantSetAttributeActionBuilder builder()

builder factory method for VariantSetAttributeAction

Returns:

builder

builder

static VariantSetAttributeActionBuilder builder(VariantSetAttributeAction template)

create builder for VariantSetAttributeAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withVariantSetAttributeAction

default <T> T withVariantSetAttributeAction(Function<VariantSetAttributeAction,T> helper)

accessor map function

Type Parameters:

T - mapped type

Parameters:

helper - function to map the object

Returns:

mapped value

typeReference

static tools.jackson.core.type.TypeReference<VariantSetAttributeAction> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference