Package com.commercetools.api.models.variant

Interface VariantAddExternalImageAction

All Superinterfaces:
VariantUpdateAction
public interface VariantAddExternalImageAction extends VariantUpdateAction

Adds an image to existing variant's images. Generates the VariantImageAdded Message.

Example to create an instance using the builder pattern 

     VariantAddExternalImageAction variantAddExternalImageAction = VariantAddExternalImageAction.builder()
             .image(imageBuilder -> imageBuilder)
             .build()

  • Field Details

    • ADD_EXTERNAL_IMAGE

      static final String ADD_EXTERNAL_IMAGE
      discriminator value for VariantAddExternalImageAction
      See Also:

  • Method Details

    • getImage

      @NotNull @Valid @NotNull @Valid Image getImage()

      Value to add to images.

      Returns:
      image

    • getStaged

      Boolean getStaged()

      If true, only the staged images is updated. If false, both the current and staged images is updated.

      Returns:
      staged

    • setImage

      void setImage(Image image)

      Value to add to images.

      Parameters:
      image - value to be set

    • setStaged

      void setStaged(Boolean staged)

      If true, only the staged images is updated. If false, both the current and staged images is updated.

      Parameters:
      staged - value to be set

    • of

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

    • of

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

    • copyDeep

      VariantAddExternalImageAction copyDeep()
      Specified by:
      copyDeep in interface VariantUpdateAction

    • deepCopy

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

    • builder

      static VariantAddExternalImageActionBuilder builder()
      builder factory method for VariantAddExternalImageAction
      Returns:
      builder

    • builder

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

    • withVariantAddExternalImageAction

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