Package com.commercetools.api.models.product

Interface ProductSetAssetDescriptionAction

All Superinterfaces:
ProductUpdateAction, ResourceUpdateAction<ProductUpdateAction>
public interface ProductSetAssetDescriptionAction extends ProductUpdateAction

Either variantId or sku is required. The Asset to update must be specified using either assetId or assetKey.

Example to create an instance using the builder pattern 

     ProductSetAssetDescriptionAction productSetAssetDescriptionAction = ProductSetAssetDescriptionAction.builder()
             .build()

  • Field Details

    • SET_ASSET_DESCRIPTION

      static final String SET_ASSET_DESCRIPTION
      discriminator value for ProductSetAssetDescriptionAction
      See Also:

  • 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 Asset is updated. If false, both the current and staged Asset is updated.

      Returns:
      staged

    • getAssetId

      String getAssetId()

      The id of the Asset to update.

      Returns:
      assetId

    • getAssetKey

      String getAssetKey()

      The key of the Asset to update.

      Returns:
      assetKey

    • getDescription

      @Valid @Valid LocalizedString getDescription()

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

      Returns:
      description

    • 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 Asset is updated. If false, both the current and staged Asset is updated.

      Parameters:
      staged - value to be set

    • setAssetId

      void setAssetId(String assetId)

      The id of the Asset to update.

      Parameters:
      assetId - value to be set

    • setAssetKey

      void setAssetKey(String assetKey)

      The key of the Asset to update.

      Parameters:
      assetKey - value to be set

    • setDescription

      void setDescription(LocalizedString description)

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

      Parameters:
      description - value to be set

    • of

      static ProductSetAssetDescriptionAction of()
      factory method
      Returns:
      instance of ProductSetAssetDescriptionAction

    • of

      static ProductSetAssetDescriptionAction of(ProductSetAssetDescriptionAction template)
      factory method to create a shallow copy ProductSetAssetDescriptionAction
      Parameters:
      template - instance to be copied
      Returns:
      copy instance

    • copyDeep

      ProductSetAssetDescriptionAction copyDeep()
      Specified by:
      copyDeep in interface ProductUpdateAction

    • deepCopy

      @Nullable static ProductSetAssetDescriptionAction deepCopy(@Nullable ProductSetAssetDescriptionAction template)
      factory method to create a deep copy of ProductSetAssetDescriptionAction
      Parameters:
      template - instance to be copied
      Returns:
      copy instance

    • builder

      static ProductSetAssetDescriptionActionBuilder builder()
      builder factory method for ProductSetAssetDescriptionAction
      Returns:
      builder

    • builder

      static ProductSetAssetDescriptionActionBuilder builder(ProductSetAssetDescriptionAction template)
      create builder for ProductSetAssetDescriptionAction instance
      Parameters:
      template - instance with prefilled values for the builder
      Returns:
      builder

    • withProductSetAssetDescriptionAction

      default <T> T withProductSetAssetDescriptionAction(Function<ProductSetAssetDescriptionAction,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<ProductSetAssetDescriptionAction> typeReference()
      gives a TypeReference for usage with Jackson DataBind
      Returns:
      TypeReference