Package com.commercetools.api.models.message

Class PaymentCreatedMessageBuilder

java.lang.Object
com.commercetools.api.models.message.PaymentCreatedMessageBuilder
All Implemented Interfaces:
io.vrap.rmf.base.client.Builder<PaymentCreatedMessage>
public class PaymentCreatedMessageBuilder extends Object implements io.vrap.rmf.base.client.Builder<PaymentCreatedMessage>
PaymentCreatedMessageBuilder
Example to create an instance using the builder pattern 

     PaymentCreatedMessage paymentCreatedMessage = PaymentCreatedMessage.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)
             .payment(paymentBuilder -> paymentBuilder)
             .build()

  • Constructor Details

    • PaymentCreatedMessageBuilder

      public PaymentCreatedMessageBuilder()

  • Method Details

    • id

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

      Date and time (UTC) the Message was generated.

      Parameters:
      createdAt - value to be set
      Returns:
      Builder

    • lastModifiedAt

      public PaymentCreatedMessageBuilder lastModifiedAt(ZonedDateTime lastModifiedAt)

      Value of createdAt.

      Parameters:
      lastModifiedAt - value to be set
      Returns:
      Builder

    • lastModifiedBy

      public PaymentCreatedMessageBuilder lastModifiedBy(Function<LastModifiedByBuilder,LastModifiedByBuilder> builder)

      Value of createdBy.

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

    • withLastModifiedBy

      public PaymentCreatedMessageBuilder withLastModifiedBy(Function<LastModifiedByBuilder,LastModifiedBy> builder)

      Value of createdBy.

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

    • lastModifiedBy

      public PaymentCreatedMessageBuilder lastModifiedBy(@Nullable LastModifiedBy lastModifiedBy)

      Value of createdBy.

      Parameters:
      lastModifiedBy - value to be set
      Returns:
      Builder

    • createdBy

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

      Present on resources created after 1 February 2019 except for events not tracked.

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

    • withCreatedBy

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

      Present on resources created after 1 February 2019 except for events not tracked.

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

    • createdBy

      public PaymentCreatedMessageBuilder createdBy(@Nullable CreatedBy createdBy)

      Present on resources created after 1 February 2019 except for events not tracked.

      Parameters:
      createdBy - value to be set
      Returns:
      Builder

    • sequenceNumber

      public PaymentCreatedMessageBuilder 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 PaymentCreatedMessageBuilder 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 PaymentCreatedMessageBuilder resource(Function<ReferenceBuilder,io.vrap.rmf.base.client.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 PaymentCreatedMessageBuilder 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 PaymentCreatedMessageBuilder 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 PaymentCreatedMessageBuilder 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 PaymentCreatedMessageBuilder 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

    • payment

      public PaymentCreatedMessageBuilder payment(Function<PaymentBuilder,PaymentBuilder> builder)

      Payment that was created.

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

    • withPayment

      public PaymentCreatedMessageBuilder withPayment(Function<PaymentBuilder,Payment> builder)

      Payment that was created.

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

    • payment

      public PaymentCreatedMessageBuilder payment(Payment payment)

      Payment that was created.

      Parameters:
      payment - 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()

      Value of createdBy.

      Returns:
      lastModifiedBy

    • getCreatedBy

      @Nullable public CreatedBy getCreatedBy()

      Present on resources created after 1 February 2019 except for events not tracked.

      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

    • getPayment

      public Payment getPayment()

      Payment that was created.

      Returns:
      payment

    • build

      public PaymentCreatedMessage build()
      builds PaymentCreatedMessage with checking for non-null required values
      Specified by:
      build in interface io.vrap.rmf.base.client.Builder<PaymentCreatedMessage>
      Returns:
      PaymentCreatedMessage

    • buildUnchecked

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

    • of

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

    • of

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