Class ProductCreatedMessageBuilder

java.lang.Object
com.commercetools.api.models.message.ProductCreatedMessageBuilder
All Implemented Interfaces:
Builder<ProductCreatedMessage>

public class ProductCreatedMessageBuilder extends Object implements Builder<ProductCreatedMessage>
ProductCreatedMessageBuilder
Example to create an instance using the builder pattern

     ProductCreatedMessage productCreatedMessage = ProductCreatedMessage.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)
             .productProjection(productProjectionBuilder -> productProjectionBuilder)
             .build()
 
  • Constructor Details

    • ProductCreatedMessageBuilder

      public ProductCreatedMessageBuilder()
  • Method Details

    • 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 ProductCreatedMessageBuilder 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 ProductCreatedMessageBuilder createdAt(ZonedDateTime createdAt)

      Date and time (UTC) the Message was generated.

      Parameters:
      createdAt - value to be set
      Returns:
      Builder
    • lastModifiedAt

      public ProductCreatedMessageBuilder lastModifiedAt(ZonedDateTime lastModifiedAt)

      Value of createdAt.

      Parameters:
      lastModifiedAt - value to be set
      Returns:
      Builder
    • lastModifiedBy

      Value of createdBy.

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

      Value of createdBy.

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

      public ProductCreatedMessageBuilder lastModifiedBy(@Nullable LastModifiedBy lastModifiedBy)

      Value of createdBy.

      Parameters:
      lastModifiedBy - value to be set
      Returns:
      Builder
    • createdBy

      Present on resources created after 1 February 2019 except for events not tracked.

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

      Present on resources created after 1 February 2019 except for events not tracked.

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

      public ProductCreatedMessageBuilder createdBy(@Nullable CreatedBy createdBy)

      Present on resources created after 1 February 2019 except for events not tracked.

      Parameters:
      createdBy - value to be set
      Returns:
      Builder
    • sequenceNumber

      public ProductCreatedMessageBuilder 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 ProductCreatedMessageBuilder resource(Reference resource)

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

      Parameters:
      resource - value to be set
      Returns:
      Builder
    • resource

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

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

      public ProductCreatedMessageBuilder resourceVersion(Long resourceVersion)

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

      Parameters:
      resourceVersion - value to be set
      Returns:
      Builder
    • resourceUserProvidedIdentifiers

      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

      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 ProductCreatedMessageBuilder 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
    • productProjection

      The staged Product Projection of the Product at the time of creation.

      Parameters:
      builder - function to build the productProjection value
      Returns:
      Builder
    • withProductProjection

      The staged Product Projection of the Product at the time of creation.

      Parameters:
      builder - function to build the productProjection value
      Returns:
      Builder
    • productProjection

      public ProductCreatedMessageBuilder productProjection(ProductProjection productProjection)

      The staged Product Projection of the Product at the time of creation.

      Parameters:
      productProjection - 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()

      Value of createdBy.

      Returns:
      lastModifiedBy
    • getCreatedBy

      @Nullable public CreatedBy getCreatedBy()

      Present on resources created after 1 February 2019 except for events not tracked.

      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
    • getProductProjection

      public ProductProjection getProductProjection()

      The staged Product Projection of the Product at the time of creation.

      Returns:
      productProjection
    • build

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

      public ProductCreatedMessage buildUnchecked()
      builds ProductCreatedMessage without checking for non-null required values
      Returns:
      ProductCreatedMessage
    • of

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

      create builder for ProductCreatedMessage instance
      Parameters:
      template - instance with prefilled values for the builder
      Returns:
      builder