Package com.commercetools.api.models.message

Class ProductVariantDeletedMessageBuilder

java.lang.Object
com.commercetools.api.models.message.ProductVariantDeletedMessageBuilder
All Implemented Interfaces:
Builder<ProductVariantDeletedMessage>
public class ProductVariantDeletedMessageBuilder extends Object implements Builder<ProductVariantDeletedMessage>
ProductVariantDeletedMessageBuilder
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()

  • Constructor Details

    • ProductVariantDeletedMessageBuilder

      public ProductVariantDeletedMessageBuilder()

  • Method Details

    • id

      public ProductVariantDeletedMessageBuilder id(String id)

      Unique identifier of the Message. Can be used to track which Messages have been processed.

      Parameters:
      id - value to be set
      Returns:
      Builder

    • version

      public ProductVariantDeletedMessageBuilder version(Long version)

      Version of a resource. In case of Messages, this is always 1.

      Parameters:
      version - value to be set
      Returns:
      Builder

    • createdAt

      public ProductVariantDeletedMessageBuilder createdAt(ZonedDateTime createdAt)

      Date and time (UTC) the Message was generated.

      Parameters:
      createdAt - value to be set
      Returns:
      Builder

    • lastModifiedAt

      public ProductVariantDeletedMessageBuilder lastModifiedAt(ZonedDateTime lastModifiedAt)

      Value of createdAt.

      Parameters:
      lastModifiedAt - value to be set
      Returns:
      Builder

    • lastModifiedBy

      public ProductVariantDeletedMessageBuilder lastModifiedBy(Function<LastModifiedByBuilder,LastModifiedByBuilder> builder)

      IDs and references that last modified the Message.

      Parameters:
      builder - function to build the lastModifiedBy value
      Returns:
      Builder

    • withLastModifiedBy

      public ProductVariantDeletedMessageBuilder withLastModifiedBy(Function<LastModifiedByBuilder,LastModifiedBy> builder)

      IDs and references that last modified the Message.

      Parameters:
      builder - function to build the lastModifiedBy value
      Returns:
      Builder

    • lastModifiedBy

      public ProductVariantDeletedMessageBuilder lastModifiedBy(@Nullable LastModifiedBy lastModifiedBy)

      IDs and references that last modified the Message.

      Parameters:
      lastModifiedBy - value to be set
      Returns:
      Builder

    • createdBy

      public ProductVariantDeletedMessageBuilder createdBy(Function<CreatedByBuilder,CreatedByBuilder> builder)

      IDs and references that created the Message.

      Parameters:
      builder - function to build the createdBy value
      Returns:
      Builder

    • withCreatedBy

      public ProductVariantDeletedMessageBuilder withCreatedBy(Function<CreatedByBuilder,CreatedBy> builder)

      IDs and references that created the Message.

      Parameters:
      builder - function to build the createdBy value
      Returns:
      Builder

    • createdBy

      public ProductVariantDeletedMessageBuilder createdBy(@Nullable CreatedBy createdBy)

      IDs and references that created the Message.

      Parameters:
      createdBy - value to be set
      Returns:
      Builder

    • sequenceNumber

      public ProductVariantDeletedMessageBuilder sequenceNumber(Long sequenceNumber)

      Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

      Parameters:
      sequenceNumber - value to be set
      Returns:
      Builder

    • resource

      public ProductVariantDeletedMessageBuilder resource(Reference resource)

      Reference to the resource on which the change or action was performed.

      Parameters:
      resource - value to be set
      Returns:
      Builder

    • resource

      public ProductVariantDeletedMessageBuilder resource(Function<ReferenceBuilder,Builder<? extends Reference>> builder)

      Reference to the resource on which the change or action was performed.

      Parameters:
      builder - function to build the resource value
      Returns:
      Builder

    • resourceVersion

      public ProductVariantDeletedMessageBuilder resourceVersion(Long resourceVersion)

      Version of the resource on which the change or action was performed.

      Parameters:
      resourceVersion - value to be set
      Returns:
      Builder

    • resourceUserProvidedIdentifiers

      public ProductVariantDeletedMessageBuilder resourceUserProvidedIdentifiers(Function<UserProvidedIdentifiersBuilder,UserProvidedIdentifiersBuilder> builder)

      User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

      Parameters:
      builder - function to build the resourceUserProvidedIdentifiers value
      Returns:
      Builder

    • withResourceUserProvidedIdentifiers

      public ProductVariantDeletedMessageBuilder withResourceUserProvidedIdentifiers(Function<UserProvidedIdentifiersBuilder,UserProvidedIdentifiers> builder)

      User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

      Parameters:
      builder - function to build the resourceUserProvidedIdentifiers value
      Returns:
      Builder

    • resourceUserProvidedIdentifiers

      public ProductVariantDeletedMessageBuilder resourceUserProvidedIdentifiers(@Nullable UserProvidedIdentifiers resourceUserProvidedIdentifiers)

      User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

      Parameters:
      resourceUserProvidedIdentifiers - value to be set
      Returns:
      Builder

    • variant

      public ProductVariantDeletedMessageBuilder variant(Function<ProductVariantBuilder,ProductVariantBuilder> builder)

      Unique identifier of the Product Variant that was added.

      Parameters:
      builder - function to build the variant value
      Returns:
      Builder

    • withVariant

      public ProductVariantDeletedMessageBuilder withVariant(Function<ProductVariantBuilder,ProductVariant> builder)

      Unique identifier of the Product Variant that was added.

      Parameters:
      builder - function to build the variant value
      Returns:
      Builder

    • variant

      public ProductVariantDeletedMessageBuilder variant(@Nullable ProductVariant variant)

      Unique identifier of the Product Variant that was added.

      Parameters:
      variant - value to be set
      Returns:
      Builder

    • removedImageUrls

      public ProductVariantDeletedMessageBuilder removedImageUrls(String... removedImageUrls)

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

      Parameters:
      removedImageUrls - value to be set
      Returns:
      Builder

    • removedImageUrls

      public ProductVariantDeletedMessageBuilder removedImageUrls(List<String> removedImageUrls)

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

      Parameters:
      removedImageUrls - value to be set
      Returns:
      Builder

    • plusRemovedImageUrls

      public ProductVariantDeletedMessageBuilder plusRemovedImageUrls(String... removedImageUrls)

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

      Parameters:
      removedImageUrls - value to be set
      Returns:
      Builder

    • staged

      public ProductVariantDeletedMessageBuilder staged(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
      Returns:
      Builder

    • getId

      public String getId()

      Unique identifier of the Message. Can be used to track which Messages have been processed.

      Returns:
      id

    • getVersion

      public Long getVersion()

      Version of a resource. In case of Messages, this is always 1.

      Returns:
      version

    • getCreatedAt

      public ZonedDateTime getCreatedAt()

      Date and time (UTC) the Message was generated.

      Returns:
      createdAt

    • getLastModifiedAt

      public ZonedDateTime getLastModifiedAt()

      Value of createdAt.

      Returns:
      lastModifiedAt

    • getLastModifiedBy

      @Nullable public LastModifiedBy getLastModifiedBy()

      IDs and references that last modified the Message.

      Returns:
      lastModifiedBy

    • getCreatedBy

      @Nullable public CreatedBy getCreatedBy()

      IDs and references that created the Message.

      Returns:
      createdBy

    • getSequenceNumber

      public Long getSequenceNumber()

      Message number in relation to other Messages for a given resource. The sequenceNumber of the next Message for the resource is the successor of the sequenceNumber of the current Message. Meaning, the sequenceNumber of the next Message equals the sequenceNumber of the current Message + 1. sequenceNumber can be used to ensure that Messages are processed in the correct order for a particular resource.

      Returns:
      sequenceNumber

    • getResource

      public Reference getResource()

      Reference to the resource on which the change or action was performed.

      Returns:
      resource

    • getResourceVersion

      public Long getResourceVersion()

      Version of the resource on which the change or action was performed.

      Returns:
      resourceVersion

    • getResourceUserProvidedIdentifiers

      @Nullable public UserProvidedIdentifiers getResourceUserProvidedIdentifiers()

      User-provided identifiers of the resource, such as key or externalId. Only present if the resource has such identifiers.

      Returns:
      resourceUserProvidedIdentifiers

    • getVariant

      @Nullable public ProductVariant getVariant()

      Unique identifier of the Product Variant that was added.

      Returns:
      variant

    • getRemovedImageUrls

      public List<String> getRemovedImageUrls()

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

      Returns:
      removedImageUrls

    • getStaged

      public 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

    • build

      public ProductVariantDeletedMessage build()
      builds ProductVariantDeletedMessage with checking for non-null required values
      Specified by:
      build in interface Builder<ProductVariantDeletedMessage>
      Returns:
      ProductVariantDeletedMessage

    • buildUnchecked

      public ProductVariantDeletedMessage buildUnchecked()
      builds ProductVariantDeletedMessage without checking for non-null required values
      Returns:
      ProductVariantDeletedMessage

    • of

      public static ProductVariantDeletedMessageBuilder of()
      factory method for an instance of ProductVariantDeletedMessageBuilder
      Returns:
      builder

    • of

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