Package com.commercetools.api.models.message

Class VariantImagesSetMessageBuilder

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

     VariantImagesSetMessage variantImagesSetMessage = VariantImagesSetMessage.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)
             .plusImages(imagesBuilder -> imagesBuilder)
             .plusOldImages(oldImagesBuilder -> oldImagesBuilder)
             .staged(true)
             .build()

  • Constructor Details

    • VariantImagesSetMessageBuilder

      public VariantImagesSetMessageBuilder()

  • Method Details

    • id

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

      Date and time (UTC) the Message was generated.

      Parameters:
      createdAt - value to be set
      Returns:
      Builder

    • lastModifiedAt

      public VariantImagesSetMessageBuilder lastModifiedAt(ZonedDateTime lastModifiedAt)

      Value of createdAt.

      Parameters:
      lastModifiedAt - value to be set
      Returns:
      Builder

    • lastModifiedBy

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

      IDs and references that last modified the Message.

      Parameters:
      lastModifiedBy - value to be set
      Returns:
      Builder

    • createdBy

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

      IDs and references that created the Message.

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

    • withCreatedBy

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

      IDs and references that created the Message.

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

    • createdBy

      public VariantImagesSetMessageBuilder createdBy(@Nullable CreatedBy createdBy)

      IDs and references that created the Message.

      Parameters:
      createdBy - value to be set
      Returns:
      Builder

    • sequenceNumber

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

    • images

      public VariantImagesSetMessageBuilder images(Image... images)

      The images that were set on the Variant.

      Parameters:
      images - value to be set
      Returns:
      Builder

    • images

      public VariantImagesSetMessageBuilder images(List<Image> images)

      The images that were set on the Variant.

      Parameters:
      images - value to be set
      Returns:
      Builder

    • plusImages

      public VariantImagesSetMessageBuilder plusImages(Image... images)

      The images that were set on the Variant.

      Parameters:
      images - value to be set
      Returns:
      Builder

    • plusImages

      public VariantImagesSetMessageBuilder plusImages(Function<ImageBuilder,ImageBuilder> builder)

      The images that were set on the Variant.

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

    • withImages

      public VariantImagesSetMessageBuilder withImages(Function<ImageBuilder,ImageBuilder> builder)

      The images that were set on the Variant.

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

    • addImages

      public VariantImagesSetMessageBuilder addImages(Function<ImageBuilder,Image> builder)

      The images that were set on the Variant.

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

    • setImages

      public VariantImagesSetMessageBuilder setImages(Function<ImageBuilder,Image> builder)

      The images that were set on the Variant.

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

    • oldImages

      public VariantImagesSetMessageBuilder oldImages(Image... oldImages)

      The previous images of the Variant.

      Parameters:
      oldImages - value to be set
      Returns:
      Builder

    • oldImages

      public VariantImagesSetMessageBuilder oldImages(List<Image> oldImages)

      The previous images of the Variant.

      Parameters:
      oldImages - value to be set
      Returns:
      Builder

    • plusOldImages

      public VariantImagesSetMessageBuilder plusOldImages(Image... oldImages)

      The previous images of the Variant.

      Parameters:
      oldImages - value to be set
      Returns:
      Builder

    • plusOldImages

      public VariantImagesSetMessageBuilder plusOldImages(Function<ImageBuilder,ImageBuilder> builder)

      The previous images of the Variant.

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

    • withOldImages

      public VariantImagesSetMessageBuilder withOldImages(Function<ImageBuilder,ImageBuilder> builder)

      The previous images of the Variant.

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

    • addOldImages

      public VariantImagesSetMessageBuilder addOldImages(Function<ImageBuilder,Image> builder)

      The previous images of the Variant.

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

    • setOldImages

      public VariantImagesSetMessageBuilder setOldImages(Function<ImageBuilder,Image> builder)

      The previous images of the Variant.

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

    • staged

      public VariantImagesSetMessageBuilder staged(Boolean staged)

      Whether the update was only applied to the staged Variant.

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

    • getImages

      public List<Image> getImages()

      The images that were set on the Variant.

      Returns:
      images

    • getOldImages

      public List<Image> getOldImages()

      The previous images of the Variant.

      Returns:
      oldImages

    • getStaged

      public Boolean getStaged()

      Whether the update was only applied to the staged Variant.

      Returns:
      staged

    • build

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

    • buildUnchecked

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

    • of

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

    • of

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