Package com.commercetools.api.models.message

Interface ProductVariantDeletedMessagePayload

All Superinterfaces:
MessagePayload, MessagePayloadMixin
public interface ProductVariantDeletedMessagePayload extends MessagePayload

Generated after a successful Remove ProductVariant update action.

Example to create an instance using the builder pattern 

     ProductVariantDeletedMessagePayload productVariantDeletedMessagePayload = ProductVariantDeletedMessagePayload.builder()
             .plusRemovedImageUrls(removedImageUrlsBuilder -> removedImageUrlsBuilder)
             .build()

  • Field Details

    • PRODUCT_VARIANT_DELETED

      static final String PRODUCT_VARIANT_DELETED
      discriminator value for ProductVariantDeletedMessagePayload
      See Also:

  • Method Details

    • getVariant

      @Valid @Valid ProductVariant getVariant()

      Unique identifier of the Product Variant that was added.

      Returns:
      variant

    • getRemovedImageUrls

      @NotNull @NotNull List<String> getRemovedImageUrls()

      List of image URLs that were removed with the Remove Product Variant update action.

      Returns:
      removedImageUrls

    • setVariant

      void setVariant(ProductVariant variant)

      Unique identifier of the Product Variant that was added.

      Parameters:
      variant - value to be set

    • setRemovedImageUrls

      void setRemovedImageUrls(String... removedImageUrls)

      List of image URLs that were removed with the Remove Product Variant update action.

      Parameters:
      removedImageUrls - values to be set

    • setRemovedImageUrls

      void setRemovedImageUrls(List<String> removedImageUrls)

      List of image URLs that were removed with the Remove Product Variant update action.

      Parameters:
      removedImageUrls - values to be set

    • of

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

    • of

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

    • deepCopy

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

    • builder

      static ProductVariantDeletedMessagePayloadBuilder builder()
      builder factory method for ProductVariantDeletedMessagePayload
      Returns:
      builder

    • builder

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

    • withProductVariantDeletedMessagePayload

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