io.sphere.sdk.products.commands.updateactions

Class RemoveAsset

java.lang.Object

io.sphere.sdk.models.Base

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

io.sphere.sdk.products.commands.updateactions.RemoveAsset

All Implemented Interfaces:

UpdateAction<Product>

public final class RemoveAsset
extends UpdateActionImpl<T>

Removes an asset.

See also ProductUpdateCommand.

By variant ID (every variant has a variantId):

withProductHavingAssets(client(), product -> {
    assertThat(product.getMasterData().hasStagedChanges()).isFalse();
    final List<Asset> originalAssets = product.getMasterData().getStaged().getMasterVariant().getAssets();
    final Asset assetToRemove = originalAssets.get(0);
    final String assetId = assetToRemove.getId();
    final Product updatedProduct = client().executeBlocking(ProductUpdateCommand.of(product, RemoveAsset.ofVariantId(MASTER_VARIANT_ID, assetId)));

    final List<Asset> assets = updatedProduct.getMasterData().getStaged().getMasterVariant().getAssets();
    assertThat(assets).hasSize(originalAssets.size() - 1);
    assertThat(assets).allMatch(asset -> !asset.getId().equals(assetId));
    assertThat(updatedProduct.getMasterData().hasStagedChanges()).isTrue();

    return updatedProduct;
});
See the test code.

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

withProductHavingAssets(client(), product -> {
    assertThat(product.getMasterData().hasStagedChanges()).isFalse();
    final ProductVariant masterVariant = product.getMasterData().getStaged().getMasterVariant();
    final String assetId = masterVariant.getAssets().get(0).getId();
    final String sku = masterVariant.getSku();
    final Product updatedProduct = client().executeBlocking(ProductUpdateCommand.of(product, RemoveAsset.ofSku(sku, assetId)));

    final List<Asset> assets = updatedProduct.getMasterData().getStaged().getMasterVariant().getAssets();
    assertThat(assets).allMatch(asset -> !asset.getId().equals(assetId));
    assertThat(updatedProduct.getMasterData().hasStagedChanges()).isTrue();

    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	getAssetId()
String	getAssetKey()
String	getSku()
Integer	getVariantId()
Boolean	isStaged()
static RemoveAsset	ofSku(String sku, String assetId)
static RemoveAsset	ofSku(String sku, String assetId, Boolean staged)
static RemoveAsset	ofSkuWithKey(String sku, String assetKey)
static RemoveAsset	ofSkuWithKey(String sku, String assetKey, Boolean staged)
static RemoveAsset	ofVariantId(Integer variantId, String assetId)
static RemoveAsset	ofVariantId(Integer variantId, String assetId, Boolean staged)
static RemoveAsset	ofVariantIdWithKey(Integer variantId, String assetKey)
static RemoveAsset	ofVariantIdWithKey(Integer variantId, String assetKey, 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

getAssetId

public String getAssetId()

getVariantId

@Nullable
public Integer getVariantId()

getSku

@Nullable
public String getSku()

getAssetKey

public String getAssetKey()

ofVariantId

public static RemoveAsset ofVariantId(Integer variantId,
                                      String assetId)

ofVariantId

public static RemoveAsset ofVariantId(Integer variantId,
                                      String assetId,
                                      @Nullable
                                      Boolean staged)

ofSku

public static RemoveAsset ofSku(String sku,
                                String assetId)

ofSku

public static RemoveAsset ofSku(String sku,
                                String assetId,
                                @Nullable
                                Boolean staged)

ofVariantIdWithKey

public static RemoveAsset ofVariantIdWithKey(Integer variantId,
                                             String assetKey)

ofVariantIdWithKey

public static RemoveAsset ofVariantIdWithKey(Integer variantId,
                                             String assetKey,
                                             @Nullable
                                             Boolean staged)

ofSkuWithKey

public static RemoveAsset ofSkuWithKey(String sku,
                                       String assetKey)

ofSkuWithKey

public static RemoveAsset ofSkuWithKey(String sku,
                                       String assetKey,
                                       @Nullable
                                       Boolean staged)

isStaged

@Nullable
public Boolean isStaged()