Package com.commercetools.api.models.message

Class OrderPaymentRemovedMessageBuilder

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

     OrderPaymentRemovedMessage orderPaymentRemovedMessage = OrderPaymentRemovedMessage.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)
             .paymentRef(paymentRefBuilder -> paymentRefBuilder)
             .removedPaymentInfo(true)
             .build()

  • Constructor Details

    • OrderPaymentRemovedMessageBuilder

      public OrderPaymentRemovedMessageBuilder()

  • Method Details

    • id

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

      Date and time (UTC) the Message was generated.

      Parameters:
      createdAt - value to be set
      Returns:
      Builder

    • lastModifiedAt

      public OrderPaymentRemovedMessageBuilder lastModifiedAt(ZonedDateTime lastModifiedAt)

      Value of createdAt.

      Parameters:
      lastModifiedAt - value to be set
      Returns:
      Builder

    • lastModifiedBy

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

      IDs and references that last modified the Message.

      Parameters:
      lastModifiedBy - value to be set
      Returns:
      Builder

    • createdBy

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

      IDs and references that created the Message.

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

    • withCreatedBy

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

      IDs and references that created the Message.

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

    • createdBy

      public OrderPaymentRemovedMessageBuilder createdBy(@Nullable CreatedBy createdBy)

      IDs and references that created the Message.

      Parameters:
      createdBy - value to be set
      Returns:
      Builder

    • sequenceNumber

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

    • paymentRef

      public OrderPaymentRemovedMessageBuilder paymentRef(Function<PaymentReferenceBuilder,PaymentReferenceBuilder> builder)

      Payment that was removed from the Order.

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

    • withPaymentRef

      public OrderPaymentRemovedMessageBuilder withPaymentRef(Function<PaymentReferenceBuilder,PaymentReference> builder)

      Payment that was removed from the Order.

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

    • paymentRef

      public OrderPaymentRemovedMessageBuilder paymentRef(PaymentReference paymentRef)

      Payment that was removed from the Order.

      Parameters:
      paymentRef - value to be set
      Returns:
      Builder

    • removedPaymentInfo

      public OrderPaymentRemovedMessageBuilder removedPaymentInfo(Boolean removedPaymentInfo)

      Indicates whether the removal of the Payment resulted in no Payments remaining on the Order. The value is true if all Payments have been removed (none remain), and false if there are still Payments associated with the Order after the removal.

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

    • getPaymentRef

      public PaymentReference getPaymentRef()

      Payment that was removed from the Order.

      Returns:
      paymentRef

    • getRemovedPaymentInfo

      public Boolean getRemovedPaymentInfo()

      Indicates whether the removal of the Payment resulted in no Payments remaining on the Order. The value is true if all Payments have been removed (none remain), and false if there are still Payments associated with the Order after the removal.

      Returns:
      removedPaymentInfo

    • build

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

    • buildUnchecked

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

    • of

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

    • of

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