io.sphere.sdk.products.commands.updateactions

Class SetAssetDescription

java.lang.Object

io.sphere.sdk.models.Base

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

io.sphere.sdk.products.commands.updateactions.SetAssetDescription

All Implemented Interfaces:

UpdateAction<Product>

public final class SetAssetDescription
extends UpdateActionImpl<T>

Changes the description of an asset.

See also ProductUpdateCommand.

By variant ID (every variant has a variantId):

withProductHavingAssets(client(), product -> {
    assertThat(product.getMasterData().hasStagedChanges()).isFalse();
    final LocalizedString newDescription = LocalizedString.ofEnglish("new description");
    final ProductVariant masterVariant = product.getMasterData().getStaged().getMasterVariant();
    final String assetId = masterVariant.getAssets().get(0).getId();

    final ProductUpdateCommand cmd =
            ProductUpdateCommand.of(product, SetAssetDescription.ofVariantId(masterVariant.getId(), assetId, newDescription));
    final Product updatedProduct = client().executeBlocking(cmd);

    final Asset updatedAsset = updatedProduct.getMasterData().getStaged().getMasterVariant().getAssets().get(0);
    assertThat(updatedAsset.getDescription()).isEqualTo(newDescription);
    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 LocalizedString newDescription = LocalizedString.ofEnglish("new description");
    final ProductVariant masterVariant = product.getMasterData().getStaged().getMasterVariant();
    final String assetId = masterVariant.getAssets().get(0).getId();

    final ProductUpdateCommand cmd =
            ProductUpdateCommand.of(product, SetAssetDescription.ofSku(masterVariant.getSku(), assetId, newDescription));
    final Product updatedProduct = client().executeBlocking(cmd);

    final Asset updatedAsset = updatedProduct.getMasterData().getStaged().getMasterVariant().getAssets().get(0);
    assertThat(updatedAsset.getDescription()).isEqualTo(newDescription);
    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()
LocalizedString	getDescription()
String	getSku()
Integer	getVariantId()
Boolean	isStaged()
static SetAssetDescription	ofSku(String sku, String assetId, LocalizedString description)
static SetAssetDescription	ofSku(String sku, String assetId, LocalizedString description, Boolean staged)
static SetAssetDescription	ofSkuAndAssetKey(String sku, String assetId, LocalizedString description)
static SetAssetDescription	ofSkuAndAssetKey(String sku, String assetKey, LocalizedString description, Boolean staged)
static SetAssetDescription	ofVariantId(Integer variantId, String assetId, LocalizedString description)
static SetAssetDescription	ofVariantId(Integer variantId, String assetId, LocalizedString description, Boolean staged)
static SetAssetDescription	ofVariantIdAndAssetKey(Integer variantId, String assetId, LocalizedString description)
static SetAssetDescription	ofVariantIdAndAssetKey(Integer variantId, String assetKey, LocalizedString description, 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()

getAssetKey

public String getAssetKey()

getVariantId

@Nullable
public Integer getVariantId()

getSku

@Nullable
public String getSku()

getDescription

@Nullable
public LocalizedString getDescription()

ofVariantId

public static SetAssetDescription ofVariantId(Integer variantId,
                                              String assetId,
                                              @Nullable
                                              LocalizedString description)

ofVariantId

public static SetAssetDescription ofVariantId(Integer variantId,
                                              String assetId,
                                              @Nullable
                                              LocalizedString description,
                                              @Nullable
                                              Boolean staged)

ofSku

public static SetAssetDescription ofSku(String sku,
                                        String assetId,
                                        @Nullable
                                        LocalizedString description)

ofSku

public static SetAssetDescription ofSku(String sku,
                                        String assetId,
                                        @Nullable
                                        LocalizedString description,
                                        @Nullable
                                        Boolean staged)

ofVariantIdAndAssetKey

public static SetAssetDescription ofVariantIdAndAssetKey(Integer variantId,
                                                         String assetId,
                                                         @Nullable
                                                         LocalizedString description)

ofVariantIdAndAssetKey

public static SetAssetDescription ofVariantIdAndAssetKey(Integer variantId,
                                                         String assetKey,
                                                         @Nullable
                                                         LocalizedString description,
                                                         @Nullable
                                                         Boolean staged)

ofSkuAndAssetKey

public static SetAssetDescription ofSkuAndAssetKey(String sku,
                                                   String assetId,
                                                   @Nullable
                                                   LocalizedString description)

ofSkuAndAssetKey

public static SetAssetDescription ofSkuAndAssetKey(String sku,
                                                   String assetKey,
                                                   @Nullable
                                                   LocalizedString description,
                                                   @Nullable
                                                   Boolean staged)

isStaged

@Nullable
public Boolean isStaged()