Package com.commercetools.api.models.variant

Interface VariantSetAssetDescriptionAction

All Superinterfaces:
VariantUpdateAction
public interface VariantSetAssetDescriptionAction extends VariantUpdateAction

Sets the description of an existing Asset on a Variant. The Asset to update must be specified using either assetId or assetKey.

Example to create an instance using the builder pattern 

     VariantSetAssetDescriptionAction variantSetAssetDescriptionAction = VariantSetAssetDescriptionAction.builder()
             .build()

  • Field Details

    • SET_ASSET_DESCRIPTION

      static final String SET_ASSET_DESCRIPTION
      discriminator value for VariantSetAssetDescriptionAction
      See Also:

  • Method Details

    • 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

    • 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 VariantSetAssetDescriptionAction of()
      factory method
      Returns:
      instance of VariantSetAssetDescriptionAction

    • of

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

    • copyDeep

      VariantSetAssetDescriptionAction copyDeep()
      Specified by:
      copyDeep in interface VariantUpdateAction

    • deepCopy

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

    • builder

      static VariantSetAssetDescriptionActionBuilder builder()
      builder factory method for VariantSetAssetDescriptionAction
      Returns:
      builder

    • builder

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

    • withVariantSetAssetDescriptionAction

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