Package com.commercetools.api.models.message

Class CustomerPasswordTokenCreatedMessageBuilder

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

     CustomerPasswordTokenCreatedMessage customerPasswordTokenCreatedMessage = CustomerPasswordTokenCreatedMessage.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)
             .customerId("{customerId}")
             .expiresAt(ZonedDateTime.parse("2022-01-01T12:00:00.301Z"))
             .invalidateOlderTokens(true)
             .build()

  • Constructor Details

    • CustomerPasswordTokenCreatedMessageBuilder

      public CustomerPasswordTokenCreatedMessageBuilder()

  • Method Details

    • id

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

      Date and time (UTC) the Message was generated.

      Parameters:
      createdAt - value to be set
      Returns:
      Builder

    • lastModifiedAt

      public CustomerPasswordTokenCreatedMessageBuilder lastModifiedAt(ZonedDateTime lastModifiedAt)

      Value of createdAt.

      Parameters:
      lastModifiedAt - value to be set
      Returns:
      Builder

    • lastModifiedBy

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

      IDs and references that last modified the Message.

      Parameters:
      lastModifiedBy - value to be set
      Returns:
      Builder

    • createdBy

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

      IDs and references that created the Message.

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

    • withCreatedBy

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

      IDs and references that created the Message.

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

    • createdBy

      public CustomerPasswordTokenCreatedMessageBuilder createdBy(@Nullable CreatedBy createdBy)

      IDs and references that created the Message.

      Parameters:
      createdBy - value to be set
      Returns:
      Builder

    • sequenceNumber

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

    • customerId

      public CustomerPasswordTokenCreatedMessageBuilder customerId(String customerId)

      Unique identifier of the Customer.

      Parameters:
      customerId - value to be set
      Returns:
      Builder

    • expiresAt

      public CustomerPasswordTokenCreatedMessageBuilder expiresAt(ZonedDateTime expiresAt)

      Date and time (UTC) the password token expires.

      Parameters:
      expiresAt - value to be set
      Returns:
      Builder

    • value

      public CustomerPasswordTokenCreatedMessageBuilder value(@Nullable String value)

      Value of the token, present only if the token's validity is 60 minutes or less.

      Parameters:
      value - value to be set
      Returns:
      Builder

    • invalidateOlderTokens

      public CustomerPasswordTokenCreatedMessageBuilder invalidateOlderTokens(Boolean invalidateOlderTokens)

      If true, all password tokens issued previously for the Customer are invalidated.

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

    • getCustomerId

      public String getCustomerId()

      Unique identifier of the Customer.

      Returns:
      customerId

    • getExpiresAt

      public ZonedDateTime getExpiresAt()

      Date and time (UTC) the password token expires.

      Returns:
      expiresAt

    • getValue

      @Nullable public String getValue()

      Value of the token, present only if the token's validity is 60 minutes or less.

      Returns:
      value

    • getInvalidateOlderTokens

      public Boolean getInvalidateOlderTokens()

      If true, all password tokens issued previously for the Customer are invalidated.

      Returns:
      invalidateOlderTokens

    • build

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

    • buildUnchecked

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

    • of

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

    • of

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