Package com.commercetools.api.models.variant

Interface VariantSetImageLabelAction

All Superinterfaces:
VariantUpdateAction
public interface VariantSetImageLabelAction extends VariantUpdateAction

Sets the label of a Variant's image.

Example to create an instance using the builder pattern 

     VariantSetImageLabelAction variantSetImageLabelAction = VariantSetImageLabelAction.builder()
             .imageUrl("{imageUrl}")
             .build()

  • Field Details

    • SET_IMAGE_LABEL

      static final String SET_IMAGE_LABEL
      discriminator value for VariantSetImageLabelAction
      See Also:

  • Method Details

    • getImageUrl

      @NotNull @NotNull String getImageUrl()

      The URL of the image to set the label.

      Returns:
      imageUrl

    • getLabel

      String getLabel()

      Value to set. If omitted, any existing value is removed.

      Returns:
      label

    • getStaged

      Boolean getStaged()

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

      Returns:
      staged

    • setImageUrl

      void setImageUrl(String imageUrl)

      The URL of the image to set the label.

      Parameters:
      imageUrl - value to be set

    • setLabel

      void setLabel(String label)

      Value to set. If omitted, any existing value is removed.

      Parameters:
      label - value to be set

    • setStaged

      void setStaged(Boolean staged)

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

      Parameters:
      staged - value to be set

    • of

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

    • of

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

    • copyDeep

      VariantSetImageLabelAction copyDeep()
      Specified by:
      copyDeep in interface VariantUpdateAction

    • deepCopy

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

    • builder

      static VariantSetImageLabelActionBuilder builder()
      builder factory method for VariantSetImageLabelAction
      Returns:
      builder

    • builder

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

    • withVariantSetImageLabelAction

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