Package com.commercetools.api.models.product

Interface ProductSetKeyAction

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

     ProductSetKeyAction productSetKeyAction = ProductSetKeyAction.builder()
             .build()

  • Field Details

  • Method Details

    • getKey

      String getKey()

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

      To update a Product using the Import API and the Merchant Center, the Product key must match the pattern ^[A-Za-z0-9_-]{2,256}$.

      Returns:
      key

    • setKey

      void setKey(String key)

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

      To update a Product using the Import API and the Merchant Center, the Product key must match the pattern ^[A-Za-z0-9_-]{2,256}$.

      Parameters:
      key - value to be set

    • of

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

    • of

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

    • copyDeep

      ProductSetKeyAction copyDeep()
      Specified by:
      copyDeep in interface ProductUpdateAction

    • deepCopy

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

    • builder

      static ProductSetKeyActionBuilder builder()
      builder factory method for ProductSetKeyAction
      Returns:
      builder

    • builder

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

    • withProductSetKeyAction

      default <T> T withProductSetKeyAction(Function<ProductSetKeyAction,T> helper)
      accessor map function
      Type Parameters:
      T - mapped type
      Parameters:
      helper - function to map the object
      Returns:
      mapped value

    • ofUnset

      static ProductSetKeyAction ofUnset()

    • typeReference

      static com.fasterxml.jackson.core.type.TypeReference<ProductSetKeyAction> typeReference()
      gives a TypeReference for usage with Jackson DataBind
      Returns:
      TypeReference