Package com.commercetools.api.models.message

Class ProductDeletedMessageBuilder

java.lang.Object
com.commercetools.api.models.message.ProductDeletedMessageBuilder
All Implemented Interfaces:
Builder<ProductDeletedMessage>
public class ProductDeletedMessageBuilder extends Object implements Builder<ProductDeletedMessage>
ProductDeletedMessageBuilder
Example to create an instance using the builder pattern 

     ProductDeletedMessage productDeletedMessage = ProductDeletedMessage.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)
             .build()

  • Constructor Details

    • ProductDeletedMessageBuilder

      public ProductDeletedMessageBuilder()

  • Method Details

    • id

      public ProductDeletedMessageBuilder 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 ProductDeletedMessageBuilder 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 ProductDeletedMessageBuilder createdAt(ZonedDateTime createdAt)

      Date and time (UTC) the Message was generated.

      Parameters:
      createdAt - value to be set
      Returns:
      Builder

    • lastModifiedAt

      public ProductDeletedMessageBuilder lastModifiedAt(ZonedDateTime lastModifiedAt)

      Value of createdAt.

      Parameters:
      lastModifiedAt - value to be set
      Returns:
      Builder

    • lastModifiedBy

      public ProductDeletedMessageBuilder 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 ProductDeletedMessageBuilder 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 ProductDeletedMessageBuilder lastModifiedBy(@Nullable LastModifiedBy lastModifiedBy)

      IDs and references that last modified the Message.

      Parameters:
      lastModifiedBy - value to be set
      Returns:
      Builder

    • createdBy

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

      IDs and references that created the Message.

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

    • withCreatedBy

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

      IDs and references that created the Message.

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

    • createdBy

      public ProductDeletedMessageBuilder createdBy(@Nullable CreatedBy createdBy)

      IDs and references that created the Message.

      Parameters:
      createdBy - value to be set
      Returns:
      Builder

    • sequenceNumber

      public ProductDeletedMessageBuilder 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 ProductDeletedMessageBuilder 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 ProductDeletedMessageBuilder 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 ProductDeletedMessageBuilder 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 ProductDeletedMessageBuilder 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 ProductDeletedMessageBuilder 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 ProductDeletedMessageBuilder 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

    • removedImageUrls

      public ProductDeletedMessageBuilder removedImageUrls(String... removedImageUrls)

      List of image URLs that were removed during the Delete Product request.

      Parameters:
      removedImageUrls - value to be set
      Returns:
      Builder

    • removedImageUrls

      public ProductDeletedMessageBuilder removedImageUrls(List<String> removedImageUrls)

      List of image URLs that were removed during the Delete Product request.

      Parameters:
      removedImageUrls - value to be set
      Returns:
      Builder

    • plusRemovedImageUrls

      public ProductDeletedMessageBuilder plusRemovedImageUrls(String... removedImageUrls)

      List of image URLs that were removed during the Delete Product request.

      Parameters:
      removedImageUrls - value to be set
      Returns:
      Builder

    • currentProjection

      public ProductDeletedMessageBuilder currentProjection(Function<ProductProjectionBuilder,ProductProjectionBuilder> builder)

      Current Product Projection of the deleted Product.

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

    • withCurrentProjection

      public ProductDeletedMessageBuilder withCurrentProjection(Function<ProductProjectionBuilder,ProductProjection> builder)

      Current Product Projection of the deleted Product.

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

    • currentProjection

      public ProductDeletedMessageBuilder currentProjection(@Nullable ProductProjection currentProjection)

      Current Product Projection of the deleted Product.

      Parameters:
      currentProjection - 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

    • getRemovedImageUrls

      public List<String> getRemovedImageUrls()

      List of image URLs that were removed during the Delete Product request.

      Returns:
      removedImageUrls

    • getCurrentProjection

      @Nullable public ProductProjection getCurrentProjection()

      Current Product Projection of the deleted Product.

      Returns:
      currentProjection

    • build

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

    • buildUnchecked

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

    • of

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

    • of

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