Package com.commercetools.api.models.message

Interface ProductVariantDeletedMessage

All Superinterfaces:
BaseResource, DomainResource<Message>, Identifiable<Message>, Message, Versioned<Message>
public interface ProductVariantDeletedMessage extends Message

Generated after a successful Remove ProductVariant update action.

Example to create an instance using the builder pattern 

     ProductVariantDeletedMessage productVariantDeletedMessage = ProductVariantDeletedMessage.builder()
             .id("{id}")
             .version(0.3)
             .createdAt(ZonedDateTime.parse("2022-01-01T12:00:00.301Z"))
             .lastModifiedAt(ZonedDateTime.parse("2022-01-01T12:00:00.301Z"))
             .sequenceNumber(0.3)
             .resource(resourceBuilder -> resourceBuilder)
             .resourceVersion(0.3)
             .plusRemovedImageUrls(removedImageUrlsBuilder -> removedImageUrlsBuilder)
             .staged(true)
             .build()

  • Field Details

    • PRODUCT_VARIANT_DELETED

      static final String PRODUCT_VARIANT_DELETED
      discriminator value for ProductVariantDeletedMessage
      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

    • getStaged

      @NotNull @NotNull Boolean getStaged()

      If true, this message informs that only the staged ProductVariant has been removed by the update action. If false, both the current and staged ProductVariant have been removed.

      Returns:
      staged

    • 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

    • setStaged

      void setStaged(Boolean staged)

      If true, this message informs that only the staged ProductVariant has been removed by the update action. If false, both the current and staged ProductVariant have been removed.

      Parameters:
      staged - value to be set

    • of

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

    • of

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

    • copyDeep

      ProductVariantDeletedMessage copyDeep()
      Specified by:
      copyDeep in interface BaseResource
      Specified by:
      copyDeep in interface Message

    • deepCopy

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

    • builder

      static ProductVariantDeletedMessageBuilder builder()
      builder factory method for ProductVariantDeletedMessage
      Returns:
      builder

    • builder

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

    • withProductVariantDeletedMessage

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