Package com.commercetools.api.models.product

Interface ProductSetPriceKeyAction

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

Sets the key of an Embedded Price. Produces the ProductPriceKeySet Message.

Example to create an instance using the builder pattern 

     ProductSetPriceKeyAction productSetPriceKeyAction = ProductSetPriceKeyAction.builder()
             .priceId("{priceId}")
             .build()

  • Field Details

  • Method Details

    • getPriceId

      @NotNull @NotNull String getPriceId()

      The id of the Price to set the key.

      Returns:
      priceId

    • getStaged

      Boolean getStaged()

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

      Returns:
      staged

    • getKey

      String getKey()

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

      Returns:
      key

    • setPriceId

      void setPriceId(String priceId)

      The id of the Price to set the key.

      Parameters:
      priceId - value to be set

    • setStaged

      void setStaged(Boolean staged)

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

      Parameters:
      staged - value to be set

    • setKey

      void setKey(String key)

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

      Parameters:
      key - value to be set

    • of

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

    • of

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

    • copyDeep

      ProductSetPriceKeyAction copyDeep()
      Specified by:
      copyDeep in interface ProductUpdateAction

    • deepCopy

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

    • builder

      static ProductSetPriceKeyActionBuilder builder()
      builder factory method for ProductSetPriceKeyAction
      Returns:
      builder

    • builder

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

    • withProductSetPriceKeyAction

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