io.sphere.sdk.products.commands.updateactions

Class SetAssetCustomField

java.lang.Object

io.sphere.sdk.models.Base

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

io.sphere.sdk.types.customupdateactions.SetCustomFieldBase<Product>

io.sphere.sdk.products.commands.updateactions.SetAssetCustomField

All Implemented Interfaces:

UpdateAction<Product>

public final class SetAssetCustomField
extends SetCustomFieldBase<Product>

This action sets, overwrites or removes any existing custom field for an existing Asset.

See also ProductUpdateCommand.

By variant ID (every variant has a variantId):

withUpdateableType(client(), (Type type) -> {
    withProductHavingAssets(client(), product -> {
        assertThat(product.getMasterData().hasStagedChanges()).isFalse();
        final ProductVariant masterVariant = product.getMasterData().getStaged().getMasterVariant();
        final Asset assetWithoutCustomType = masterVariant.getAssets().get(0);
        final String assetId = assetWithoutCustomType.getId();

        final String firstFieldValue = "commercetools";
        final CustomFieldsDraft customFieldsDraft = CustomFieldsDraftBuilder.ofType(type)
                .addObject(STRING_FIELD_NAME, firstFieldValue)
                .build();
        final Integer variantId = masterVariant.getId();
        final ProductUpdateCommand cmd = ProductUpdateCommand.of(product,
                SetAssetCustomType.ofVariantId(variantId, assetId, customFieldsDraft));
        final Product updatedProductWithCustomTypeInAssets = client().executeBlocking(cmd);

        final String actualFieldValue = updatedProductWithCustomTypeInAssets.getMasterData()
                .getStaged().getMasterVariant()
                .getAssets().get(0).getCustom().getFieldAsString(STRING_FIELD_NAME);
        assertThat(actualFieldValue).isEqualTo(firstFieldValue);

        final Product updatedProduct = client().executeBlocking(ProductUpdateCommand.of(updatedProductWithCustomTypeInAssets,
                SetAssetCustomField.ofVariantId(variantId, assetId, STRING_FIELD_NAME, "new")));

        assertThat(updatedProduct.getMasterData()
                .getStaged().getMasterVariant()
                .getAssets().get(0).getCustom().getFieldAsString(STRING_FIELD_NAME))
                .isEqualTo("new");
        assertThat(updatedProduct.getMasterData().hasStagedChanges()).isTrue();

        return updatedProduct;
    });
    return type;
});
See the test code.

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

withUpdateableType(client(), (Type type) -> {
    withProductHavingAssets(client(), product -> {
        assertThat(product.getMasterData().hasStagedChanges()).isFalse();
        final ProductVariant masterVariant = product.getMasterData().getStaged().getMasterVariant();
        final Asset assetWithoutCustomType = masterVariant.getAssets().get(0);
        final String assetId = assetWithoutCustomType.getId();

        final String firstFieldValue = "commercetools";
        final CustomFieldsDraft customFieldsDraft = CustomFieldsDraftBuilder.ofType(type)
                .addObject(STRING_FIELD_NAME, firstFieldValue)
                .build();
        final String sku = masterVariant.getSku();
        final ProductUpdateCommand cmd = ProductUpdateCommand.of(product,
                SetAssetCustomType.ofSku(sku, assetId, customFieldsDraft));
        final Product updatedProductWithCustomTypeInAssets = client().executeBlocking(cmd);

        final String actualFieldValue = updatedProductWithCustomTypeInAssets.getMasterData()
                .getStaged().getMasterVariant()
                .getAssets().get(0).getCustom().getFieldAsString(STRING_FIELD_NAME);
        assertThat(actualFieldValue).isEqualTo(firstFieldValue);

        final Product updatedProduct = client().executeBlocking(ProductUpdateCommand.of(updatedProductWithCustomTypeInAssets,
                SetAssetCustomField.ofSku(sku, assetId, STRING_FIELD_NAME, "new")));

        assertThat(updatedProduct.getMasterData()
                .getStaged().getMasterVariant()
                .getAssets().get(0).getCustom().getFieldAsString(STRING_FIELD_NAME))
                .isEqualTo("new");
        assertThat(updatedProduct.getMasterData().hasStagedChanges()).isTrue();

        return updatedProduct;
    });
    return type;
});
See the test code.

See Also:

Custom

Method Summary

Modifier and Type	Method and Description
String	getAssetId()
String	getAssetKey()
String	getSku()
Boolean	getStaged()
Integer	getVariantId()
static SetAssetCustomField	ofSku(String sku, String assetId, String name, Object value)
static SetAssetCustomField	ofSku(String sku, String assetId, String name, Object value, Boolean staged)
static SetAssetCustomField	ofSkuAndAssetKey(String sku, String assetKey, String name, Object value)
static SetAssetCustomField	ofSkuAndAssetKey(String sku, String assetKey, String name, Object value, Boolean staged)
static SetAssetCustomField	ofSkuUsingJson(String sku, String assetId, String name, com.fasterxml.jackson.databind.JsonNode value)
static SetAssetCustomField	ofSkuUsingJson(String sku, String assetId, String name, com.fasterxml.jackson.databind.JsonNode value, Boolean staged)
static SetAssetCustomField	ofSkuUsingJsonAndAssetKey(String sku, String assetKey, String name, com.fasterxml.jackson.databind.JsonNode value)
static SetAssetCustomField	ofSkuUsingJsonAndAssetKey(String sku, String assetKey, String name, com.fasterxml.jackson.databind.JsonNode value, Boolean staged)
static SetAssetCustomField	ofVariantId(Integer variantId, String assetId, String name, Object value)
static SetAssetCustomField	ofVariantId(Integer variantId, String assetId, String name, Object value, Boolean staged)
static SetAssetCustomField	ofVariantIdAndAssetKey(Integer variantId, String assetKey, String name, Object value)
static SetAssetCustomField	ofVariantIdAndAssetKey(Integer variantId, String assetKey, String name, Object value, Boolean staged)
static SetAssetCustomField	ofVariantIdUsingJson(Integer variantId, String assetId, String name, com.fasterxml.jackson.databind.JsonNode value)
static SetAssetCustomField	ofVariantIdUsingJson(Integer variantId, String assetId, String name, com.fasterxml.jackson.databind.JsonNode value, Boolean staged)
static SetAssetCustomField	ofVariantIdUsingJsonAndAssetKey(Integer variantId, String assetKey, String name, com.fasterxml.jackson.databind.JsonNode value)
static SetAssetCustomField	ofVariantIdUsingJsonAndAssetKey(Integer variantId, String assetKey, String name, com.fasterxml.jackson.databind.JsonNode value, Boolean staged)

Methods inherited from class io.sphere.sdk.types.customupdateactions.SetCustomFieldBase

getName, getValue

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

Method Detail

getAssetId

public String getAssetId()

getAssetKey

public String getAssetKey()

getVariantId

@Nullable
public Integer getVariantId()

getSku

@Nullable
public String getSku()

ofVariantIdUsingJson

public static SetAssetCustomField ofVariantIdUsingJson(Integer variantId,
                                                       String assetId,
                                                       String name,
                                                       com.fasterxml.jackson.databind.JsonNode value)

ofVariantIdUsingJson

public static SetAssetCustomField ofVariantIdUsingJson(Integer variantId,
                                                       String assetId,
                                                       String name,
                                                       com.fasterxml.jackson.databind.JsonNode value,
                                                       @Nullable
                                                       Boolean staged)

ofSkuUsingJson

public static SetAssetCustomField ofSkuUsingJson(String sku,
                                                 String assetId,
                                                 String name,
                                                 com.fasterxml.jackson.databind.JsonNode value)

ofSkuUsingJson

public static SetAssetCustomField ofSkuUsingJson(String sku,
                                                 String assetId,
                                                 String name,
                                                 com.fasterxml.jackson.databind.JsonNode value,
                                                 @Nullable
                                                 Boolean staged)

ofVariantId

public static SetAssetCustomField ofVariantId(Integer variantId,
                                              String assetId,
                                              String name,
                                              Object value)

ofVariantId

public static SetAssetCustomField ofVariantId(Integer variantId,
                                              String assetId,
                                              String name,
                                              Object value,
                                              @Nullable
                                              Boolean staged)

ofSku

public static SetAssetCustomField ofSku(String sku,
                                        String assetId,
                                        String name,
                                        Object value)

ofSku

public static SetAssetCustomField ofSku(String sku,
                                        String assetId,
                                        String name,
                                        Object value,
                                        @Nullable
                                        Boolean staged)

ofVariantIdUsingJsonAndAssetKey

public static SetAssetCustomField ofVariantIdUsingJsonAndAssetKey(Integer variantId,
                                                                  String assetKey,
                                                                  String name,
                                                                  com.fasterxml.jackson.databind.JsonNode value)

ofVariantIdUsingJsonAndAssetKey

public static SetAssetCustomField ofVariantIdUsingJsonAndAssetKey(Integer variantId,
                                                                  String assetKey,
                                                                  String name,
                                                                  com.fasterxml.jackson.databind.JsonNode value,
                                                                  @Nullable
                                                                  Boolean staged)

ofSkuUsingJsonAndAssetKey

public static SetAssetCustomField ofSkuUsingJsonAndAssetKey(String sku,
                                                            String assetKey,
                                                            String name,
                                                            com.fasterxml.jackson.databind.JsonNode value)

ofSkuUsingJsonAndAssetKey

public static SetAssetCustomField ofSkuUsingJsonAndAssetKey(String sku,
                                                            String assetKey,
                                                            String name,
                                                            com.fasterxml.jackson.databind.JsonNode value,
                                                            @Nullable
                                                            Boolean staged)

ofVariantIdAndAssetKey

public static SetAssetCustomField ofVariantIdAndAssetKey(Integer variantId,
                                                         String assetKey,
                                                         String name,
                                                         Object value)

ofVariantIdAndAssetKey

public static SetAssetCustomField ofVariantIdAndAssetKey(Integer variantId,
                                                         String assetKey,
                                                         String name,
                                                         Object value,
                                                         @Nullable
                                                         Boolean staged)

ofSkuAndAssetKey

public static SetAssetCustomField ofSkuAndAssetKey(String sku,
                                                   String assetKey,
                                                   String name,
                                                   Object value)

ofSkuAndAssetKey

public static SetAssetCustomField ofSkuAndAssetKey(String sku,
                                                   String assetKey,
                                                   String name,
                                                   Object value,
                                                   @Nullable
                                                   Boolean staged)

getStaged

@Nullable
public Boolean getStaged()