Package com.commercetools.api.models.message

Interface VariantKeySetMessagePayload

All Superinterfaces:
MessagePayload, MessagePayloadMixin
public interface VariantKeySetMessagePayload extends MessagePayload

Generated after a successful Set Key update action.

Example to create an instance using the builder pattern 

     VariantKeySetMessagePayload variantKeySetMessagePayload = VariantKeySetMessagePayload.builder()
             .build()

  • Field Details

    • VARIANT_KEY_SET

      static final String VARIANT_KEY_SET
      discriminator value for VariantKeySetMessagePayload
      See Also:

  • Method Details

    • getKey

      String getKey()

      The key that was set on the Variant.

      Returns:
      key

    • getOldKey

      String getOldKey()

      The previous key of the Variant.

      Returns:
      oldKey

    • setKey

      void setKey(String key)

      The key that was set on the Variant.

      Parameters:
      key - value to be set

    • setOldKey

      void setOldKey(String oldKey)

      The previous key of the Variant.

      Parameters:
      oldKey - value to be set

    • of

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

    • of

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

    • copyDeep

      VariantKeySetMessagePayload copyDeep()
      Specified by:
      copyDeep in interface MessagePayload

    • deepCopy

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

    • builder

      static VariantKeySetMessagePayloadBuilder builder()
      builder factory method for VariantKeySetMessagePayload
      Returns:
      builder

    • builder

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

    • withVariantKeySetMessagePayload

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

    • typeReference

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