io.sphere.sdk.products.commands.updateactions

Class RemoveImage

java.lang.Object

io.sphere.sdk.models.Base

io.sphere.sdk.commands.UpdateActionImpl<T>

io.sphere.sdk.products.commands.updateactions.RemoveImage

All Implemented Interfaces:

UpdateAction<Product>

public final class RemoveImage
extends UpdateActionImpl<T>

Removes a product image. Also deletes it from the Content Delivery Network (it would not be deleted from the CDN in case of external image). Deletion from the CDN is not instant, which means the image file itself will stay available for some time after the deletion.

See also ProductUpdateCommand.

By variant ID (every variant has a variantId):

final Image image = createExternalImage();
withUpdateableProduct(client(), product -> {
    final Product productWithImage = client().executeBlocking(ProductUpdateCommand.of(product, AddExternalImage.ofVariantId(MASTER_VARIANT_ID, image)));
    assertThat(productWithImage.getMasterData().getStaged().getMasterVariant().getImages()).isEqualTo(asList(image));

    final Product updatedProduct = client().executeBlocking(ProductUpdateCommand.of(productWithImage, RemoveImage.ofVariantId(MASTER_VARIANT_ID, image)));
    assertThat(updatedProduct.getMasterData().getStaged().getMasterVariant().getImages()).hasSize(0);
    return updatedProduct;
});
See the test code.

By SKU (attention, SKU is optional field in a variant):

final Image image = createExternalImage();
withUpdateableProduct(client(), product -> {
    final String sku = product.getMasterData().getStaged().getMasterVariant().getSku();
    final Product productWithImage = client().executeBlocking(ProductUpdateCommand.of(product, AddExternalImage.ofSku(sku, image)));
    assertThat(productWithImage.getMasterData().getStaged().getMasterVariant().getImages()).isEqualTo(asList(image));

    final Product updatedProduct = client().executeBlocking(ProductUpdateCommand.of(productWithImage, RemoveImage.ofSku(sku, image)));
    assertThat(updatedProduct.getMasterData().getStaged().getMasterVariant().getImages()).hasSize(0);
    return updatedProduct;
});
See the test code.

Field Summary

Fields

Modifier and Type	Field and Description
protected Boolean	staged

Method Summary

Modifier and Type	Method and Description
String	getImageUrl()
String	getSku()
Integer	getVariantId()
Boolean	isStaged()
static RemoveImage	of(Image image, Integer variantId)
static RemoveImage	of(String imageUrl, Integer variantId)
static RemoveImage	ofSku(String sku, Image image)
static RemoveImage	ofSku(String sku, Image image, Boolean staged)
static RemoveImage	ofSku(String sku, String imageUrl)
static RemoveImage	ofSku(String sku, String imageUrl, Boolean staged)
static RemoveImage	ofVariantId(Integer variantId, Image image)
static RemoveImage	ofVariantId(Integer variantId, Image image, Boolean staged)
static RemoveImage	ofVariantId(Integer variantId, String imageUrl)
static RemoveImage	ofVariantId(Integer variantId, String imageUrl, Boolean staged)

Methods inherited from class io.sphere.sdk.commands.UpdateActionImpl

getAction

Methods inherited from class io.sphere.sdk.models.Base

equals, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

staged

@Nullable
protected final Boolean staged

Method Detail

getImageUrl

public String getImageUrl()

getVariantId

@Nullable
public Integer getVariantId()

getSku

@Nullable
public String getSku()

of

public static RemoveImage of(Image image,
                             Integer variantId)

of

public static RemoveImage of(String imageUrl,
                             Integer variantId)

ofVariantId

public static RemoveImage ofVariantId(Integer variantId,
                                      Image image)

ofVariantId

public static RemoveImage ofVariantId(Integer variantId,
                                      String imageUrl)

ofVariantId

public static RemoveImage ofVariantId(Integer variantId,
                                      Image image,
                                      @Nullable
                                      Boolean staged)

ofVariantId

public static RemoveImage ofVariantId(Integer variantId,
                                      String imageUrl,
                                      @Nullable
                                      Boolean staged)

ofSku

public static RemoveImage ofSku(String sku,
                                Image image)

ofSku

public static RemoveImage ofSku(String sku,
                                Image image,
                                @Nullable
                                Boolean staged)

ofSku

public static RemoveImage ofSku(String sku,
                                String imageUrl)

ofSku

public static RemoveImage ofSku(String sku,
                                String imageUrl,
                                @Nullable
                                Boolean staged)

isStaged

@Nullable
public Boolean isStaged()