Package com.commercetools.api.models.message

Class DeliveryCustomTypeSetMessageBuilder

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

     DeliveryCustomTypeSetMessage deliveryCustomTypeSetMessage = DeliveryCustomTypeSetMessage.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)
             .customFields(customFieldsBuilder -> customFieldsBuilder)
             .deliveryId("{deliveryId}")
             .build()

  • Constructor Details

    • DeliveryCustomTypeSetMessageBuilder

      public DeliveryCustomTypeSetMessageBuilder()

  • Method Details

    • id

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

      Date and time (UTC) the Message was generated.

      Parameters:
      createdAt - value to be set
      Returns:
      Builder

    • lastModifiedAt

      public DeliveryCustomTypeSetMessageBuilder lastModifiedAt(ZonedDateTime lastModifiedAt)

      Value of createdAt.

      Parameters:
      lastModifiedAt - value to be set
      Returns:
      Builder

    • lastModifiedBy

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

      IDs and references that last modified the Message.

      Parameters:
      lastModifiedBy - value to be set
      Returns:
      Builder

    • createdBy

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

      IDs and references that created the Message.

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

    • withCreatedBy

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

      IDs and references that created the Message.

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

    • createdBy

      public DeliveryCustomTypeSetMessageBuilder createdBy(@Nullable CreatedBy createdBy)

      IDs and references that created the Message.

      Parameters:
      createdBy - value to be set
      Returns:
      Builder

    • sequenceNumber

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

    • customFields

      public DeliveryCustomTypeSetMessageBuilder customFields(Function<CustomFieldsBuilder,CustomFieldsBuilder> builder)

      The Custom Fields that have been set.

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

    • withCustomFields

      public DeliveryCustomTypeSetMessageBuilder withCustomFields(Function<CustomFieldsBuilder,CustomFields> builder)

      The Custom Fields that have been set.

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

    • customFields

      public DeliveryCustomTypeSetMessageBuilder customFields(CustomFields customFields)

      The Custom Fields that have been set.

      Parameters:
      customFields - value to be set
      Returns:
      Builder

    • previousTypeId

      public DeliveryCustomTypeSetMessageBuilder previousTypeId(@Nullable String previousTypeId)

      id of the previous Custom Type. Absent if there was no previous Custom Type present.

      Parameters:
      previousTypeId - value to be set
      Returns:
      Builder

    • deliveryId

      public DeliveryCustomTypeSetMessageBuilder deliveryId(String deliveryId)

      Unique identifier of the Delivery.

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

    • getCustomFields

      public CustomFields getCustomFields()

      The Custom Fields that have been set.

      Returns:
      customFields

    • getPreviousTypeId

      @Nullable public String getPreviousTypeId()

      id of the previous Custom Type. Absent if there was no previous Custom Type present.

      Returns:
      previousTypeId

    • getDeliveryId

      public String getDeliveryId()

      Unique identifier of the Delivery.

      Returns:
      deliveryId

    • build

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

    • buildUnchecked

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

    • of

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

    • of

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