Package com.commercetools.api.models.message

Class ApprovalFlowCompletedMessageBuilder

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

     ApprovalFlowCompletedMessage approvalFlowCompletedMessage = ApprovalFlowCompletedMessage.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)
             .status(ApprovalFlowStatus.PENDING)
             .order(orderBuilder -> orderBuilder)
             .build()

  • Constructor Details

    • ApprovalFlowCompletedMessageBuilder

      public ApprovalFlowCompletedMessageBuilder()

  • Method Details

    • id

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

      Date and time (UTC) the Message was generated.

      Parameters:
      createdAt - value to be set
      Returns:
      Builder

    • lastModifiedAt

      public ApprovalFlowCompletedMessageBuilder lastModifiedAt(ZonedDateTime lastModifiedAt)

      Value of createdAt.

      Parameters:
      lastModifiedAt - value to be set
      Returns:
      Builder

    • lastModifiedBy

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

      IDs and references that last modified the Message.

      Parameters:
      lastModifiedBy - value to be set
      Returns:
      Builder

    • createdBy

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

      IDs and references that created the Message.

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

    • withCreatedBy

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

      IDs and references that created the Message.

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

    • createdBy

      public ApprovalFlowCompletedMessageBuilder createdBy(@Nullable CreatedBy createdBy)

      IDs and references that created the Message.

      Parameters:
      createdBy - value to be set
      Returns:
      Builder

    • sequenceNumber

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

    • status

      public ApprovalFlowCompletedMessageBuilder status(ApprovalFlowStatus status)

      Final status of the Approval Flow.

      Parameters:
      status - value to be set
      Returns:
      Builder

    • order

      public ApprovalFlowCompletedMessageBuilder order(Function<OrderReferenceBuilder,OrderReferenceBuilder> builder)

      Reference to the Order related to the completed Approval Flow.

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

    • withOrder

      public ApprovalFlowCompletedMessageBuilder withOrder(Function<OrderReferenceBuilder,OrderReference> builder)

      Reference to the Order related to the completed Approval Flow.

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

    • order

      public ApprovalFlowCompletedMessageBuilder order(OrderReference order)

      Reference to the Order related to the completed Approval Flow.

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

    • getStatus

      public ApprovalFlowStatus getStatus()

      Final status of the Approval Flow.

      Returns:
      status

    • getOrder

      public OrderReference getOrder()

      Reference to the Order related to the completed Approval Flow.

      Returns:
      order

    • build

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

    • buildUnchecked

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

    • of

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

    • of

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