Package com.commercetools.api.models.product

Interface ProductSetProductVariantKeyAction

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

Either variantId or sku is required.

Example to create an instance using the builder pattern 

     ProductSetProductVariantKeyAction productSetProductVariantKeyAction = ProductSetProductVariantKeyAction.builder()
             .build()

  • Field Details

    • SET_PRODUCT_VARIANT_KEY

      static final String SET_PRODUCT_VARIANT_KEY
      discriminator value for ProductSetProductVariantKeyAction
      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

    • getKey

      String getKey()

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

      Returns:
      key

    • getStaged

      Boolean getStaged()

      If true, only the staged key is set. If false, both the current and staged key are set.

      Returns:
      staged

    • 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

    • setKey

      void setKey(String key)

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

      Parameters:
      key - value to be set

    • setStaged

      void setStaged(Boolean staged)

      If true, only the staged key is set. If false, both the current and staged key are set.

      Parameters:
      staged - value to be set

    • of

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

    • of

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

    • copyDeep

      ProductSetProductVariantKeyAction copyDeep()
      Specified by:
      copyDeep in interface ProductUpdateAction

    • deepCopy

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

    • builder

      static ProductSetProductVariantKeyActionBuilder builder()
      builder factory method for ProductSetProductVariantKeyAction
      Returns:
      builder

    • builder

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

    • withProductSetProductVariantKeyAction

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