Class ProductPriceChangedMessageBuilder

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

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

     ProductPriceChangedMessage productPriceChangedMessage = ProductPriceChangedMessage.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)
             .variantId(0.3)
             .oldPrice(oldPriceBuilder -> oldPriceBuilder)
             .newPrice(newPriceBuilder -> newPriceBuilder)
             .staged(true)
             .build()
 
  • Constructor Details

    • ProductPriceChangedMessageBuilder

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

      Date and time (UTC) the Message was generated.

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

      public ProductPriceChangedMessageBuilder lastModifiedAt(ZonedDateTime lastModifiedAt)

      Value of createdAt.

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

      IDs and references that last modified the Message.

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

      IDs and references that last modified the Message.

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

      public ProductPriceChangedMessageBuilder lastModifiedBy(@Nullable LastModifiedBy lastModifiedBy)

      IDs and references that last modified the Message.

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

      IDs and references that created the Message.

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

      IDs and references that created the Message.

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

      IDs and references that created the Message.

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

      public ProductPriceChangedMessageBuilder 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 ProductPriceChangedMessageBuilder 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 ProductPriceChangedMessageBuilder 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 ProductPriceChangedMessageBuilder 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
    • variantId

      public ProductPriceChangedMessageBuilder variantId(Long variantId)

      Unique identifier of the ProductVariant for which the Price was changed.

      Parameters:
      variantId - value to be set
      Returns:
      Builder
    • oldPrice

      The current Embedded Price before the Change Embedded Price update action.

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

      The current Embedded Price before the Change Embedded Price update action.

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

      public ProductPriceChangedMessageBuilder oldPrice(Price oldPrice)

      The current Embedded Price before the Change Embedded Price update action.

      Parameters:
      oldPrice - value to be set
      Returns:
      Builder
    • newPrice

      The Embedded Price after the Change Embedded Price update action.

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

      The Embedded Price after the Change Embedded Price update action.

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

      public ProductPriceChangedMessageBuilder newPrice(Price newPrice)

      The Embedded Price after the Change Embedded Price update action.

      Parameters:
      newPrice - value to be set
      Returns:
      Builder
    • staged

      Whether the update was only applied to the staged Product Projection.

      Parameters:
      staged - value to be set
      Returns:
      Builder
    • oldStagedPrice

      The staged Embedded Price before the Change Embedded Price update action.

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

      public ProductPriceChangedMessageBuilder withOldStagedPrice(Function<PriceBuilder,Price> builder)

      The staged Embedded Price before the Change Embedded Price update action.

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

      public ProductPriceChangedMessageBuilder oldStagedPrice(@Nullable Price oldStagedPrice)

      The staged Embedded Price before the Change Embedded Price update action.

      Parameters:
      oldStagedPrice - 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
    • getVariantId

      public Long getVariantId()

      Unique identifier of the ProductVariant for which the Price was changed.

      Returns:
      variantId
    • getOldPrice

      public Price getOldPrice()

      The current Embedded Price before the Change Embedded Price update action.

      Returns:
      oldPrice
    • getNewPrice

      public Price getNewPrice()

      The Embedded Price after the Change Embedded Price update action.

      Returns:
      newPrice
    • getStaged

      public Boolean getStaged()

      Whether the update was only applied to the staged Product Projection.

      Returns:
      staged
    • getOldStagedPrice

      @Nullable public Price getOldStagedPrice()

      The staged Embedded Price before the Change Embedded Price update action.

      Returns:
      oldStagedPrice
    • build

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

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

      factory method for an instance of ProductPriceChangedMessageBuilder
      Returns:
      builder
    • of

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