Package com.commercetools.api.models.message

Class OrderShippingAddressSetMessageBuilder

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

     OrderShippingAddressSetMessage orderShippingAddressSetMessage = OrderShippingAddressSetMessage.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

    • OrderShippingAddressSetMessageBuilder

      public OrderShippingAddressSetMessageBuilder()

  • Method Details

    • id

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

      Date and time (UTC) the Message was generated.

      Parameters:
      createdAt - value to be set
      Returns:
      Builder

    • lastModifiedAt

      public OrderShippingAddressSetMessageBuilder lastModifiedAt(ZonedDateTime lastModifiedAt)

      Value of createdAt.

      Parameters:
      lastModifiedAt - value to be set
      Returns:
      Builder

    • lastModifiedBy

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

      IDs and references that last modified the Message.

      Parameters:
      lastModifiedBy - value to be set
      Returns:
      Builder

    • createdBy

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

      IDs and references that created the Message.

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

    • withCreatedBy

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

      IDs and references that created the Message.

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

    • createdBy

      public OrderShippingAddressSetMessageBuilder createdBy(@Nullable CreatedBy createdBy)

      IDs and references that created the Message.

      Parameters:
      createdBy - value to be set
      Returns:
      Builder

    • sequenceNumber

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

    • address

      public OrderShippingAddressSetMessageBuilder address(Function<AddressBuilder,AddressBuilder> builder)

      Shipping address on the Order after the Set Shipping Address update action.

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

    • withAddress

      public OrderShippingAddressSetMessageBuilder withAddress(Function<AddressBuilder,Address> builder)

      Shipping address on the Order after the Set Shipping Address update action.

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

    • address

      public OrderShippingAddressSetMessageBuilder address(@Nullable Address address)

      Shipping address on the Order after the Set Shipping Address update action.

      Parameters:
      address - value to be set
      Returns:
      Builder

    • oldAddress

      public OrderShippingAddressSetMessageBuilder oldAddress(Function<AddressBuilder,AddressBuilder> builder)

      Shipping address on the Order before the Set Shipping Address update action.

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

    • withOldAddress

      public OrderShippingAddressSetMessageBuilder withOldAddress(Function<AddressBuilder,Address> builder)

      Shipping address on the Order before the Set Shipping Address update action.

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

    • oldAddress

      public OrderShippingAddressSetMessageBuilder oldAddress(@Nullable Address oldAddress)

      Shipping address on the Order before the Set Shipping Address update action.

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

    • getAddress

      @Nullable public Address getAddress()

      Shipping address on the Order after the Set Shipping Address update action.

      Returns:
      address

    • getOldAddress

      @Nullable public Address getOldAddress()

      Shipping address on the Order before the Set Shipping Address update action.

      Returns:
      oldAddress

    • build

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

    • buildUnchecked

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

    • of

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

    • of

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