Package com.commercetools.api.models.message

Class OrderShippingInfoSetMessageBuilder

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

     OrderShippingInfoSetMessage orderShippingInfoSetMessage = OrderShippingInfoSetMessage.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)
             .build()

  • Constructor Details

    • OrderShippingInfoSetMessageBuilder

      public OrderShippingInfoSetMessageBuilder()

  • Method Details

    • id

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

      Date and time (UTC) the Message was generated.

      Parameters:
      createdAt - value to be set
      Returns:
      Builder

    • lastModifiedAt

      public OrderShippingInfoSetMessageBuilder lastModifiedAt(ZonedDateTime lastModifiedAt)

      Value of createdAt.

      Parameters:
      lastModifiedAt - value to be set
      Returns:
      Builder

    • lastModifiedBy

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

      IDs and references that last modified the Message.

      Parameters:
      lastModifiedBy - value to be set
      Returns:
      Builder

    • createdBy

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

      IDs and references that created the Message.

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

    • withCreatedBy

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

      IDs and references that created the Message.

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

    • createdBy

      public OrderShippingInfoSetMessageBuilder createdBy(@Nullable CreatedBy createdBy)

      IDs and references that created the Message.

      Parameters:
      createdBy - value to be set
      Returns:
      Builder

    • sequenceNumber

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

    • shippingInfo

      public OrderShippingInfoSetMessageBuilder shippingInfo(Function<ShippingInfoBuilder,ShippingInfoBuilder> builder)

      ShippingInfo after the Set Shipping Method or Set Custom Shipping Method update action.

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

    • withShippingInfo

      public OrderShippingInfoSetMessageBuilder withShippingInfo(Function<ShippingInfoBuilder,ShippingInfo> builder)

      ShippingInfo after the Set Shipping Method or Set Custom Shipping Method update action.

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

    • shippingInfo

      public OrderShippingInfoSetMessageBuilder shippingInfo(@Nullable ShippingInfo shippingInfo)

      ShippingInfo after the Set Shipping Method or Set Custom Shipping Method update action.

      Parameters:
      shippingInfo - value to be set
      Returns:
      Builder

    • oldShippingInfo

      public OrderShippingInfoSetMessageBuilder oldShippingInfo(Function<ShippingInfoBuilder,ShippingInfoBuilder> builder)

      ShippingInfo before the Set Shipping Method or Set Custom Shipping Method update action.

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

    • withOldShippingInfo

      public OrderShippingInfoSetMessageBuilder withOldShippingInfo(Function<ShippingInfoBuilder,ShippingInfo> builder)

      ShippingInfo before the Set Shipping Method or Set Custom Shipping Method update action.

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

    • oldShippingInfo

      public OrderShippingInfoSetMessageBuilder oldShippingInfo(@Nullable ShippingInfo oldShippingInfo)

      ShippingInfo before the Set Shipping Method or Set Custom Shipping Method update action.

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

    • getShippingInfo

      @Nullable public ShippingInfo getShippingInfo()

      ShippingInfo after the Set Shipping Method or Set Custom Shipping Method update action.

      Returns:
      shippingInfo

    • getOldShippingInfo

      @Nullable public ShippingInfo getOldShippingInfo()

      ShippingInfo before the Set Shipping Method or Set Custom Shipping Method update action.

      Returns:
      oldShippingInfo

    • build

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

    • buildUnchecked

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

    • of

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

    • of

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