Interface ProductRemovePriceAction
- All Superinterfaces:
ProductUpdateAction
,ResourceUpdateAction<ProductUpdateAction>
- All Known Implementing Classes:
ProductRemovePriceActionImpl
Example to create an instance using the builder pattern
ProductRemovePriceAction productRemovePriceAction = ProductRemovePriceAction.builder()
.priceId("{priceId}")
.build()
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
discriminator value for ProductRemovePriceAction -
Method Summary
Modifier and TypeMethodDescriptionbuilder()
builder factory method for ProductRemovePriceActionbuilder
(ProductRemovePriceAction template) create builder for ProductRemovePriceAction instancestatic ProductRemovePriceAction
deepCopy
(ProductRemovePriceAction template) factory method to create a deep copy of ProductRemovePriceAction@Valid PriceDraft
getPrice()
The Price identical to the one to be removed from the ProductVariant.@NotNull String
Theid
of the Embedded Price to remove.getSku()
Thesku
of the ProductVariant the provided Price should be removed from.Iftrue
, only the staged Embedded Price is removed.Theid
of the ProductVariant the provided Price should be removed from.static ProductRemovePriceAction
of()
factory methodstatic ProductRemovePriceAction
of
(ProductRemovePriceAction template) factory method to create a shallow copy ProductRemovePriceActionvoid
setPrice
(PriceDraft price) The Price identical to the one to be removed from the ProductVariant.void
setPriceId
(String priceId) Theid
of the Embedded Price to remove.void
Thesku
of the ProductVariant the provided Price should be removed from.void
Iftrue
, only the staged Embedded Price is removed.void
setVariantId
(Long variantId) Theid
of the ProductVariant the provided Price should be removed from.static com.fasterxml.jackson.core.type.TypeReference<ProductRemovePriceAction>
gives a TypeReference for usage with Jackson DataBinddefault <T> T
accessor map functionMethods inherited from interface com.commercetools.api.models.product.ProductUpdateAction
getAction, withProductUpdateAction
Methods inherited from interface com.commercetools.api.models.ResourceUpdateAction
get
-
Field Details
-
REMOVE_PRICE
discriminator value for ProductRemovePriceAction- See Also:
-
-
Method Details
-
getPriceId
The
id
of the Embedded Price to remove.- Returns:
- priceId
-
getSku
The
sku
of the ProductVariant the provided Price should be removed from. Either 'variantId' or 'sku' is required" whenpriceId
is not provided. This field is now deprecated, use 'priceId' instead.- Returns:
- sku
-
getVariantId
The
id
of the ProductVariant the provided Price should be removed from. Either 'variantId' or 'sku' is required" whenpriceId
is not provided. This field is now deprecated, use 'priceId' instead.- Returns:
- variantId
-
getPrice
The Price identical to the one to be removed from the ProductVariant. This field is now deprecated, use 'priceId' instead.
- Returns:
- price
-
getStaged
If
true
, only the staged Embedded Price is removed. Iffalse
, both the current and staged Embedded Price are removed.- Returns:
- staged
-
setPriceId
The
id
of the Embedded Price to remove.- Parameters:
priceId
- value to be set
-
setSku
The
sku
of the ProductVariant the provided Price should be removed from. Either 'variantId' or 'sku' is required" whenpriceId
is not provided. This field is now deprecated, use 'priceId' instead.- Parameters:
sku
- value to be set
-
setVariantId
The
id
of the ProductVariant the provided Price should be removed from. Either 'variantId' or 'sku' is required" whenpriceId
is not provided. This field is now deprecated, use 'priceId' instead.- Parameters:
variantId
- value to be set
-
setPrice
The Price identical to the one to be removed from the ProductVariant. This field is now deprecated, use 'priceId' instead.
- Parameters:
price
- value to be set
-
setStaged
If
true
, only the staged Embedded Price is removed. Iffalse
, both the current and staged Embedded Price are removed.- Parameters:
staged
- value to be set
-
of
factory method- Returns:
- instance of ProductRemovePriceAction
-
of
factory method to create a shallow copy ProductRemovePriceAction- Parameters:
template
- instance to be copied- Returns:
- copy instance
-
deepCopy
factory method to create a deep copy of ProductRemovePriceAction- Parameters:
template
- instance to be copied- Returns:
- copy instance
-
builder
builder factory method for ProductRemovePriceAction- Returns:
- builder
-
builder
create builder for ProductRemovePriceAction instance- Parameters:
template
- instance with prefilled values for the builder- Returns:
- builder
-
withProductRemovePriceAction
accessor map function- Type Parameters:
T
- mapped type- Parameters:
helper
- function to map the object- Returns:
- mapped value
-
typeReference
gives a TypeReference for usage with Jackson DataBind- Returns:
- TypeReference
-