Package com.commercetools.api.models.product

Interface ProductSetDescriptionAction

All Superinterfaces:
ProductUpdateAction, ResourceUpdateAction<ProductUpdateAction>
public interface ProductSetDescriptionAction extends ProductUpdateAction
ProductSetDescriptionAction
Example to create an instance using the builder pattern 

     ProductSetDescriptionAction productSetDescriptionAction = ProductSetDescriptionAction.builder()
             .build()

  • Field Details

    • SET_DESCRIPTION

      static final String SET_DESCRIPTION
      discriminator value for ProductSetDescriptionAction
      See Also:

  • Method Details

    • getDescription

      @Valid @Valid LocalizedString getDescription()

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

      Returns:
      description

    • getStaged

      Boolean getStaged()

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

      Returns:
      staged

    • setDescription

      void setDescription(LocalizedString description)

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

      Parameters:
      description - value to be set

    • setStaged

      void setStaged(Boolean staged)

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

      Parameters:
      staged - value to be set

    • of

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

    • of

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

    • copyDeep

      ProductSetDescriptionAction copyDeep()
      Specified by:
      copyDeep in interface ProductUpdateAction

    • deepCopy

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

    • builder

      static ProductSetDescriptionActionBuilder builder()
      builder factory method for ProductSetDescriptionAction
      Returns:
      builder

    • builder

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

    • withProductSetDescriptionAction

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