Package com.commercetools.api.models.message

Class StoreNameSetMessageBuilder

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

     StoreNameSetMessage storeNameSetMessage = StoreNameSetMessage.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

    • StoreNameSetMessageBuilder

      public StoreNameSetMessageBuilder()

  • Method Details

    • id

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

      Date and time (UTC) the Message was generated.

      Parameters:
      createdAt - value to be set
      Returns:
      Builder

    • lastModifiedAt

      public StoreNameSetMessageBuilder lastModifiedAt(ZonedDateTime lastModifiedAt)

      Value of createdAt.

      Parameters:
      lastModifiedAt - value to be set
      Returns:
      Builder

    • lastModifiedBy

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

      IDs and references that last modified the Message.

      Parameters:
      lastModifiedBy - value to be set
      Returns:
      Builder

    • createdBy

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

      IDs and references that created the Message.

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

    • withCreatedBy

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

      IDs and references that created the Message.

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

    • createdBy

      public StoreNameSetMessageBuilder createdBy(@Nullable CreatedBy createdBy)

      IDs and references that created the Message.

      Parameters:
      createdBy - value to be set
      Returns:
      Builder

    • sequenceNumber

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

    • name

      public StoreNameSetMessageBuilder name(Function<LocalizedStringBuilder,LocalizedStringBuilder> builder)

      Name of the Store set during the Set Name update action.

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

    • withName

      public StoreNameSetMessageBuilder withName(Function<LocalizedStringBuilder,LocalizedString> builder)

      Name of the Store set during the Set Name update action.

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

    • name

      public StoreNameSetMessageBuilder name(@Nullable LocalizedString name)

      Name of the Store set during the Set Name update action.

      Parameters:
      name - value to be set
      Returns:
      Builder

    • nameAllLocales

      public StoreNameSetMessageBuilder nameAllLocales(@Nullable LocalizedString... nameAllLocales)

      Names set for the Store in different locales.

      Parameters:
      nameAllLocales - value to be set
      Returns:
      Builder

    • nameAllLocales

      public StoreNameSetMessageBuilder nameAllLocales(@Nullable List<LocalizedString> nameAllLocales)

      Names set for the Store in different locales.

      Parameters:
      nameAllLocales - value to be set
      Returns:
      Builder

    • plusNameAllLocales

      public StoreNameSetMessageBuilder plusNameAllLocales(@Nullable LocalizedString... nameAllLocales)

      Names set for the Store in different locales.

      Parameters:
      nameAllLocales - value to be set
      Returns:
      Builder

    • plusNameAllLocales

      public StoreNameSetMessageBuilder plusNameAllLocales(Function<LocalizedStringBuilder,LocalizedStringBuilder> builder)

      Names set for the Store in different locales.

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

    • withNameAllLocales

      public StoreNameSetMessageBuilder withNameAllLocales(Function<LocalizedStringBuilder,LocalizedStringBuilder> builder)

      Names set for the Store in different locales.

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

    • addNameAllLocales

      public StoreNameSetMessageBuilder addNameAllLocales(Function<LocalizedStringBuilder,LocalizedString> builder)

      Names set for the Store in different locales.

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

    • setNameAllLocales

      public StoreNameSetMessageBuilder setNameAllLocales(Function<LocalizedStringBuilder,LocalizedString> builder)

      Names set for the Store in different locales.

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

    • getName

      @Nullable public LocalizedString getName()

      Name of the Store set during the Set Name update action.

      Returns:
      name

    • getNameAllLocales

      @Nullable public List<LocalizedString> getNameAllLocales()

      Names set for the Store in different locales.

      Returns:
      nameAllLocales

    • build

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

    • buildUnchecked

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

    • of

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

    • of

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