Package com.commercetools.api.models.message

Class ProductPriceCustomFieldAddedMessageBuilder

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

     ProductPriceCustomFieldAddedMessage productPriceCustomFieldAddedMessage = ProductPriceCustomFieldAddedMessage.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)
             .priceId("{priceId}")
             .variantId(0.3)
             .staged(true)
             .name("{name}")
             .build()

  • Constructor Details

    • ProductPriceCustomFieldAddedMessageBuilder

      public ProductPriceCustomFieldAddedMessageBuilder()

  • Method Details

    • id

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

      Date and time (UTC) the Message was generated.

      Parameters:
      createdAt - value to be set
      Returns:
      Builder

    • lastModifiedAt

      public ProductPriceCustomFieldAddedMessageBuilder lastModifiedAt(ZonedDateTime lastModifiedAt)

      Value of createdAt.

      Parameters:
      lastModifiedAt - value to be set
      Returns:
      Builder

    • lastModifiedBy

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

      IDs and references that last modified the Message.

      Parameters:
      lastModifiedBy - value to be set
      Returns:
      Builder

    • createdBy

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

      IDs and references that created the Message.

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

    • withCreatedBy

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

      IDs and references that created the Message.

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

    • createdBy

      public ProductPriceCustomFieldAddedMessageBuilder createdBy(@Nullable CreatedBy createdBy)

      IDs and references that created the Message.

      Parameters:
      createdBy - value to be set
      Returns:
      Builder

    • sequenceNumber

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

    • priceId

      public ProductPriceCustomFieldAddedMessageBuilder priceId(String priceId)

      Unique identifier of the Price to which the Custom Field was added.

      Parameters:
      priceId - value to be set
      Returns:
      Builder

    • variantId

      public ProductPriceCustomFieldAddedMessageBuilder variantId(Long variantId)

      Unique identifier of the ProductVariant to which the Price belongs.

      Parameters:
      variantId - value to be set
      Returns:
      Builder

    • staged

      public ProductPriceCustomFieldAddedMessageBuilder staged(Boolean staged)

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

      Parameters:
      staged - value to be set
      Returns:
      Builder

    • name

      public ProductPriceCustomFieldAddedMessageBuilder name(String name)

      Name of the Custom Field that was added.

      Parameters:
      name - value to be set
      Returns:
      Builder

    • value

      public ProductPriceCustomFieldAddedMessageBuilder value(Object value)

      The added CustomFieldValue based on the FieldType.

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

    • getPriceId

      public String getPriceId()

      Unique identifier of the Price to which the Custom Field was added.

      Returns:
      priceId

    • getVariantId

      public Long getVariantId()

      Unique identifier of the ProductVariant to which the Price belongs.

      Returns:
      variantId

    • getStaged

      public Boolean getStaged()

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

      Returns:
      staged

    • getName

      public String getName()

      Name of the Custom Field that was added.

      Returns:
      name

    • getValue

      public Object getValue()

      The added CustomFieldValue based on the FieldType.

      Returns:
      value

    • build

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

    • buildUnchecked

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

    • of

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

    • of

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