Class ProductPriceKeySetMessageBuilder

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

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

     ProductPriceKeySetMessage productPriceKeySetMessage = ProductPriceKeySetMessage.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)
             .staged(true)
             .build()
 
  • Constructor Details

    • ProductPriceKeySetMessageBuilder

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

      Date and time (UTC) the Message was generated.

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

      public ProductPriceKeySetMessageBuilder 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 ProductPriceKeySetMessageBuilder 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 ProductPriceKeySetMessageBuilder 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 ProductPriceKeySetMessageBuilder 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 ProductPriceKeySetMessageBuilder 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 ProductPriceKeySetMessageBuilder 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 ProductPriceKeySetMessageBuilder variantId(Long variantId)
      set the value to the variantId
      Parameters:
      variantId - value to be set
      Returns:
      Builder
    • priceId

      Unique identifier of the Price.

      Parameters:
      priceId - value to be set
      Returns:
      Builder
    • oldKey

      key value of the Price before the Set Price Key update action.

      Parameters:
      oldKey - value to be set
      Returns:
      Builder
    • key

      key value of the Price after the Set Price Key update action.

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

      public ProductPriceKeySetMessageBuilder 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()
      value of variantId}
      Returns:
      variantId
    • getPriceId

      @Nullable public String getPriceId()

      Unique identifier of the Price.

      Returns:
      priceId
    • getOldKey

      @Nullable public String getOldKey()

      key value of the Price before the Set Price Key update action.

      Returns:
      oldKey
    • getKey

      @Nullable public String getKey()

      key value of the Price after the Set Price Key update action.

      Returns:
      key
    • getStaged

      public Boolean getStaged()

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

      Returns:
      staged
    • build

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

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

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

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