Package com.commercetools.api.models.product

Interface ProductChangeAssetOrderAction

All Superinterfaces:

ProductUpdateAction, ResourceUpdateAction<ProductUpdateAction>

All Known Implementing Classes:

ProductChangeAssetOrderActionImpl

public interface ProductChangeAssetOrderAction
extends ProductUpdateAction

Either variantId or sku is required.

Example to create an instance using the builder pattern

     ProductChangeAssetOrderAction productChangeAssetOrderAction = ProductChangeAssetOrderAction.builder()
             .plusAssetOrder(assetOrderBuilder -> assetOrderBuilder)
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CHANGE_ASSET_ORDER	discriminator value for ProductChangeAssetOrderAction

Method Summary

Modifier and Type	Method	Description
static ProductChangeAssetOrderActionBuilder	builder()	builder factory method for ProductChangeAssetOrderAction
static ProductChangeAssetOrderActionBuilder	builder(ProductChangeAssetOrderAction template)	create builder for ProductChangeAssetOrderAction instance
static ProductChangeAssetOrderAction	deepCopy(ProductChangeAssetOrderAction template)	factory method to create a deep copy of ProductChangeAssetOrderAction
@NotNull List<String>	getAssetOrder()	All existing Asset ids of the ProductVariant in the desired new order.
String	getSku()	The sku of the ProductVariant to update.
Boolean	getStaged()	If true, only the staged assets is updated.
Long	getVariantId()	The id of the ProductVariant to update.
static ProductChangeAssetOrderAction	of()	factory method
static ProductChangeAssetOrderAction	of(ProductChangeAssetOrderAction template)	factory method to create a shallow copy ProductChangeAssetOrderAction
void	setAssetOrder(String... assetOrder)	All existing Asset ids of the ProductVariant in the desired new order.
void	setAssetOrder(List<String> assetOrder)	All existing Asset ids of the ProductVariant in the desired new order.
void	setSku(String sku)	The sku of the ProductVariant to update.
void	setStaged(Boolean staged)	If true, only the staged assets is updated.
void	setVariantId(Long variantId)	The id of the ProductVariant to update.
static com.fasterxml.jackson.core.type.TypeReference<ProductChangeAssetOrderAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withProductChangeAssetOrderAction(Function<ProductChangeAssetOrderAction,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

CHANGE_ASSET_ORDER

static final String CHANGE_ASSET_ORDER

discriminator value for ProductChangeAssetOrderAction

See Also:

• Constant Field Values

Method Details

getVariantId

Long getVariantId()

The id of the ProductVariant to update.

Returns:

variantId

getSku

String getSku()

The sku of the ProductVariant to update.

Returns:

sku

getStaged

Boolean getStaged()

If true, only the staged assets is updated. If false, both the current and staged assets are updated.

Returns:

staged

getAssetOrder

@NotNull
@NotNull List<String> getAssetOrder()

All existing Asset ids of the ProductVariant in the desired new order.

Returns:

assetOrder

setVariantId

void setVariantId(Long variantId)

The id of the ProductVariant to update.

Parameters:

variantId - value to be set

setSku

void setSku(String sku)

The sku of the ProductVariant to update.

Parameters:

sku - value to be set

setStaged

void setStaged(Boolean staged)

If true, only the staged assets is updated. If false, both the current and staged assets are updated.

Parameters:

staged - value to be set

setAssetOrder

void setAssetOrder(String... assetOrder)

All existing Asset ids of the ProductVariant in the desired new order.

Parameters:

assetOrder - values to be set

setAssetOrder

void setAssetOrder(List<String> assetOrder)

All existing Asset ids of the ProductVariant in the desired new order.

Parameters:

assetOrder - values to be set

of

static ProductChangeAssetOrderAction of()

factory method

Returns:

instance of ProductChangeAssetOrderAction

of

static ProductChangeAssetOrderAction of(ProductChangeAssetOrderAction template)

factory method to create a shallow copy ProductChangeAssetOrderAction

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static ProductChangeAssetOrderAction deepCopy(@Nullable
 ProductChangeAssetOrderAction template)

factory method to create a deep copy of ProductChangeAssetOrderAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static ProductChangeAssetOrderActionBuilder builder()

builder factory method for ProductChangeAssetOrderAction

Returns:

builder

builder

static ProductChangeAssetOrderActionBuilder builder(ProductChangeAssetOrderAction template)

create builder for ProductChangeAssetOrderAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withProductChangeAssetOrderAction

default <T> T withProductChangeAssetOrderAction(Function<ProductChangeAssetOrderAction,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<ProductChangeAssetOrderAction> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference