Package com.commercetools.api.models.message

Interface UserProvidedIdentifiers

public interface UserProvidedIdentifiers

User-provided identifiers present on the resource for which the Message is created. The value of the identifier stored in the Message corresponds to the one that was set on the resource at the version shown in resourceVersion.

Example to create an instance using the builder pattern 

     UserProvidedIdentifiers userProvidedIdentifiers = UserProvidedIdentifiers.builder()
             .build()

  • Method Details

    • getKey

      String getKey()

      User-provided unique identifier of the resource.

      Returns:
      key

    • getExternalId

      String getExternalId()

      User-provided unique identifier of the resource.

      Returns:
      externalId

    • getOrderNumber

      String getOrderNumber()

      User-provided unique identifier of an Order.

      Returns:
      orderNumber

    • getCustomerNumber

      String getCustomerNumber()

      User-provided unique identifier of a Customer.

      Returns:
      customerNumber

    • getSku

      String getSku()

      Unique SKU of a Product Variant.

      Returns:
      sku

    • getSlug

      @Valid @Valid LocalizedString getSlug()

      Unique identifier usually used in deep-link URLs for a Product. The value corresponds to the slug in the current Product Projection.

      Returns:
      slug

    • getContainerAndKey

      @Valid @Valid ContainerAndKey getContainerAndKey()

      Unique identifier of a Custom Object.

      Returns:
      containerAndKey

    • setKey

      void setKey(String key)

      User-provided unique identifier of the resource.

      Parameters:
      key - value to be set

    • setExternalId

      void setExternalId(String externalId)

      User-provided unique identifier of the resource.

      Parameters:
      externalId - value to be set

    • setOrderNumber

      void setOrderNumber(String orderNumber)

      User-provided unique identifier of an Order.

      Parameters:
      orderNumber - value to be set

    • setCustomerNumber

      void setCustomerNumber(String customerNumber)

      User-provided unique identifier of a Customer.

      Parameters:
      customerNumber - value to be set

    • setSku

      void setSku(String sku)

      Unique SKU of a Product Variant.

      Parameters:
      sku - value to be set

    • setSlug

      void setSlug(LocalizedString slug)

      Unique identifier usually used in deep-link URLs for a Product. The value corresponds to the slug in the current Product Projection.

      Parameters:
      slug - value to be set

    • setContainerAndKey

      void setContainerAndKey(ContainerAndKey containerAndKey)

      Unique identifier of a Custom Object.

      Parameters:
      containerAndKey - value to be set

    • of

      static UserProvidedIdentifiers of()
      factory method
      Returns:
      instance of UserProvidedIdentifiers

    • of

      static UserProvidedIdentifiers of(UserProvidedIdentifiers template)
      factory method to create a shallow copy UserProvidedIdentifiers
      Parameters:
      template - instance to be copied
      Returns:
      copy instance

    • copyDeep

      UserProvidedIdentifiers copyDeep()

    • deepCopy

      @Nullable static UserProvidedIdentifiers deepCopy(@Nullable UserProvidedIdentifiers template)
      factory method to create a deep copy of UserProvidedIdentifiers
      Parameters:
      template - instance to be copied
      Returns:
      copy instance

    • builder

      static UserProvidedIdentifiersBuilder builder()
      builder factory method for UserProvidedIdentifiers
      Returns:
      builder

    • builder

      static UserProvidedIdentifiersBuilder builder(UserProvidedIdentifiers template)
      create builder for UserProvidedIdentifiers instance
      Parameters:
      template - instance with prefilled values for the builder
      Returns:
      builder

    • withUserProvidedIdentifiers

      default <T> T withUserProvidedIdentifiers(Function<UserProvidedIdentifiers,T> helper)
      accessor map function
      Type Parameters:
      T - mapped type
      Parameters:
      helper - function to map the object
      Returns:
      mapped value

    • typeReference

      static com.fasterxml.jackson.core.type.TypeReference<UserProvidedIdentifiers> typeReference()
      gives a TypeReference for usage with Jackson DataBind
      Returns:
      TypeReference