Package com.commercetools.api.models.message

Class ReturnInfoSetMessageBuilder

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

     ReturnInfoSetMessage returnInfoSetMessage = ReturnInfoSetMessage.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

    • ReturnInfoSetMessageBuilder

      public ReturnInfoSetMessageBuilder()

  • Method Details

    • id

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

      Date and time (UTC) the Message was generated.

      Parameters:
      createdAt - value to be set
      Returns:
      Builder

    • lastModifiedAt

      public ReturnInfoSetMessageBuilder lastModifiedAt(ZonedDateTime lastModifiedAt)

      Value of createdAt.

      Parameters:
      lastModifiedAt - value to be set
      Returns:
      Builder

    • lastModifiedBy

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

      IDs and references that last modified the Message.

      Parameters:
      lastModifiedBy - value to be set
      Returns:
      Builder

    • createdBy

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

      IDs and references that created the Message.

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

    • withCreatedBy

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

      IDs and references that created the Message.

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

    • createdBy

      public ReturnInfoSetMessageBuilder createdBy(@Nullable CreatedBy createdBy)

      IDs and references that created the Message.

      Parameters:
      createdBy - value to be set
      Returns:
      Builder

    • sequenceNumber

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

    • returnInfo

      public ReturnInfoSetMessageBuilder returnInfo(@Nullable ReturnInfo... returnInfo)

      The ReturnInfo that was set on the Order or Order Edit.

      Parameters:
      returnInfo - value to be set
      Returns:
      Builder

    • returnInfo

      public ReturnInfoSetMessageBuilder returnInfo(@Nullable List<ReturnInfo> returnInfo)

      The ReturnInfo that was set on the Order or Order Edit.

      Parameters:
      returnInfo - value to be set
      Returns:
      Builder

    • plusReturnInfo

      public ReturnInfoSetMessageBuilder plusReturnInfo(@Nullable ReturnInfo... returnInfo)

      The ReturnInfo that was set on the Order or Order Edit.

      Parameters:
      returnInfo - value to be set
      Returns:
      Builder

    • plusReturnInfo

      public ReturnInfoSetMessageBuilder plusReturnInfo(Function<ReturnInfoBuilder,ReturnInfoBuilder> builder)

      The ReturnInfo that was set on the Order or Order Edit.

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

    • withReturnInfo

      public ReturnInfoSetMessageBuilder withReturnInfo(Function<ReturnInfoBuilder,ReturnInfoBuilder> builder)

      The ReturnInfo that was set on the Order or Order Edit.

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

    • addReturnInfo

      public ReturnInfoSetMessageBuilder addReturnInfo(Function<ReturnInfoBuilder,ReturnInfo> builder)

      The ReturnInfo that was set on the Order or Order Edit.

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

    • setReturnInfo

      public ReturnInfoSetMessageBuilder setReturnInfo(Function<ReturnInfoBuilder,ReturnInfo> builder)

      The ReturnInfo that was set on the Order or Order Edit.

      Parameters:
      builder - function to build the returnInfo value
      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

    • getReturnInfo

      @Nullable public List<ReturnInfo> getReturnInfo()

      The ReturnInfo that was set on the Order or Order Edit.

      Returns:
      returnInfo

    • build

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

    • buildUnchecked

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

    • of

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

    • of

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