Package com.commercetools.api.models.message

Class ProductPricesSetMessageBuilder

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

     ProductPricesSetMessage productPricesSetMessage = ProductPricesSetMessage.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)
             .plusPrices(pricesBuilder -> pricesBuilder)
             .staged(true)
             .build()

  • Constructor Details

    • ProductPricesSetMessageBuilder

      public ProductPricesSetMessageBuilder()

  • Method Details

    • id

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

      Date and time (UTC) the Message was generated.

      Parameters:
      createdAt - value to be set
      Returns:
      Builder

    • lastModifiedAt

      public ProductPricesSetMessageBuilder lastModifiedAt(ZonedDateTime lastModifiedAt)

      Value of createdAt.

      Parameters:
      lastModifiedAt - value to be set
      Returns:
      Builder

    • lastModifiedBy

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

      IDs and references that last modified the Message.

      Parameters:
      lastModifiedBy - value to be set
      Returns:
      Builder

    • createdBy

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

      IDs and references that created the Message.

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

    • withCreatedBy

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

      IDs and references that created the Message.

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

    • createdBy

      public ProductPricesSetMessageBuilder createdBy(@Nullable CreatedBy createdBy)

      IDs and references that created the Message.

      Parameters:
      createdBy - value to be set
      Returns:
      Builder

    • sequenceNumber

      public ProductPricesSetMessageBuilder 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 ProductPricesSetMessageBuilder 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 ProductPricesSetMessageBuilder 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 ProductPricesSetMessageBuilder 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 ProductPricesSetMessageBuilder 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 ProductPricesSetMessageBuilder 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 ProductPricesSetMessageBuilder 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 ProductPricesSetMessageBuilder variantId(Long variantId)

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

      Parameters:
      variantId - value to be set
      Returns:
      Builder

    • prices

      public ProductPricesSetMessageBuilder prices(Price... prices)

      The Embedded Prices that were set on the ProductVariant.

      Parameters:
      prices - value to be set
      Returns:
      Builder

    • prices

      public ProductPricesSetMessageBuilder prices(List<Price> prices)

      The Embedded Prices that were set on the ProductVariant.

      Parameters:
      prices - value to be set
      Returns:
      Builder

    • plusPrices

      public ProductPricesSetMessageBuilder plusPrices(Price... prices)

      The Embedded Prices that were set on the ProductVariant.

      Parameters:
      prices - value to be set
      Returns:
      Builder

    • plusPrices

      public ProductPricesSetMessageBuilder plusPrices(Function<PriceBuilder,PriceBuilder> builder)

      The Embedded Prices that were set on the ProductVariant.

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

    • withPrices

      public ProductPricesSetMessageBuilder withPrices(Function<PriceBuilder,PriceBuilder> builder)

      The Embedded Prices that were set on the ProductVariant.

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

    • addPrices

      public ProductPricesSetMessageBuilder addPrices(Function<PriceBuilder,Price> builder)

      The Embedded Prices that were set on the ProductVariant.

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

    • setPrices

      public ProductPricesSetMessageBuilder setPrices(Function<PriceBuilder,Price> builder)

      The Embedded Prices that were set on the ProductVariant.

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

    • staged

      public ProductPricesSetMessageBuilder staged(Boolean staged)

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

      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

    • getVariantId

      public Long getVariantId()

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

      Returns:
      variantId

    • getPrices

      public List<Price> getPrices()

      The Embedded Prices that were set on the ProductVariant.

      Returns:
      prices

    • getStaged

      public Boolean getStaged()

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

      Returns:
      staged

    • build

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

    • buildUnchecked

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

    • of

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

    • of

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