Package com.commercetools.api.models.variant

Interface VariantBulkUpdate

public interface VariantBulkUpdate

The request body for a bulk update of Variants.

Example to create an instance using the builder pattern 

     VariantBulkUpdate variantBulkUpdate = VariantBulkUpdate.builder()
             .plusItems(itemsBuilder -> itemsBuilder)
             .plusActions(actionsBuilder -> actionsBuilder)
             .build()

  • Method Details

    • getItems

      @NotNull @Valid @NotNull @Valid List<VariantBulkUpdateItem> getItems()

      List of Variants to update. Each item must identify the Variant by id or key.

      Returns:
      items

    • getActions

      @NotNull @Valid @NotNull @Valid List<VariantUpdateAction> getActions()

      The update action to apply to each Variant. Only Publish and Unpublish actions are supported. An empty array results in a no-op: all items are returned as successful with no changes applied.

      Returns:
      actions

    • setItems

      void setItems(VariantBulkUpdateItem... items)

      List of Variants to update. Each item must identify the Variant by id or key.

      Parameters:
      items - values to be set

    • setItems

      void setItems(List<VariantBulkUpdateItem> items)

      List of Variants to update. Each item must identify the Variant by id or key.

      Parameters:
      items - values to be set

    • setActions

      void setActions(VariantUpdateAction... actions)

      The update action to apply to each Variant. Only Publish and Unpublish actions are supported. An empty array results in a no-op: all items are returned as successful with no changes applied.

      Parameters:
      actions - values to be set

    • setActions

      void setActions(List<VariantUpdateAction> actions)

      The update action to apply to each Variant. Only Publish and Unpublish actions are supported. An empty array results in a no-op: all items are returned as successful with no changes applied.

      Parameters:
      actions - values to be set

    • of

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

    • of

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

    • copyDeep

      VariantBulkUpdate copyDeep()

    • deepCopy

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

    • builder

      static VariantBulkUpdateBuilder builder()
      builder factory method for VariantBulkUpdate
      Returns:
      builder

    • builder

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

    • withVariantBulkUpdate

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