Package com.commercetools.api.models.variant

Interface VariantBulkUpdateItem

public interface VariantBulkUpdateItem

Identifies a single Variant to be updated in a bulk update request. Provide either id or key to identify the Variant.

Example to create an instance using the builder pattern 

     VariantBulkUpdateItem variantBulkUpdateItem = VariantBulkUpdateItem.builder()
             .build()

  • Method Details

    • getId

      String getId()

      Unique identifier of the Variant to update. Either id or key must be provided.

      Returns:
      id

    • getKey

      String getKey()

      User-defined unique identifier of the Variant to update. Either id or key must be provided.

      Returns:
      key

    • getVersion

      Long getVersion()

      Expected version of the Variant. Required when the versionControl query parameter is On (the default). If the version does not match, a ConcurrentModification error is returned for that item. Not required when versionControl=Off.

      Returns:
      version

    • setId

      void setId(String id)

      Unique identifier of the Variant to update. Either id or key must be provided.

      Parameters:
      id - value to be set

    • setKey

      void setKey(String key)

      User-defined unique identifier of the Variant to update. Either id or key must be provided.

      Parameters:
      key - value to be set

    • setVersion

      void setVersion(Long version)

      Expected version of the Variant. Required when the versionControl query parameter is On (the default). If the version does not match, a ConcurrentModification error is returned for that item. Not required when versionControl=Off.

      Parameters:
      version - value to be set

    • of

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

    • of

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

    • copyDeep

      VariantBulkUpdateItem copyDeep()

    • deepCopy

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

    • builder

      static VariantBulkUpdateItemBuilder builder()
      builder factory method for VariantBulkUpdateItem
      Returns:
      builder

    • builder

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

    • withVariantBulkUpdateItem

      default <T> T withVariantBulkUpdateItem(Function<VariantBulkUpdateItem,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<VariantBulkUpdateItem> typeReference()
      gives a TypeReference for usage with Jackson DataBind
      Returns:
      TypeReference