io.sphere.sdk.shippingmethods.commands.updateactions

Class SetDescription

java.lang.Object

io.sphere.sdk.models.Base

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

io.sphere.sdk.shippingmethods.commands.updateactions.SetDescription

All Implemented Interfaces:

UpdateAction<ShippingMethod>

Deprecated.

This type will be removed with the next major SDK update.

@Generated(value="io.sphere.sdk.annotations.processors.generators.UpdateActionsGenerator",
           comments="Generated from: io.sphere.sdk.shippingmethods.ShippingMethod")
 @Deprecated
public final class SetDescription
extends UpdateActionImpl<ShippingMethod>

Sets the description property of a ShippingMethod.

withUpdateableShippingMethod(client(), shippingMethod -> {
    final String newDescription = randomString();
    assertThat(shippingMethod.getDescription()).isNotEqualTo(newDescription);
    final ShippingMethodUpdateCommand cmd = ShippingMethodUpdateCommand.of(shippingMethod, SetDescription.of(newDescription));
    final ShippingMethod updatedShippingMethod = client().executeBlocking(cmd);
    assertThat(updatedShippingMethod.getDescription()).isEqualTo(newDescription);
    return updatedShippingMethod;
});
See the test code.

See Also:

ShippingMethod.getDescription()

Method Summary

Modifier and Type	Method and Description
String	getDescription() Deprecated. This method will be removed with the next major SDK update.
static SetDescription	of(String description) Deprecated. Creates a new update action from the given parameters.
static SetDescription	ofUnset() Deprecated. Creates a new update action to unset the description property.

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

getDescription

@Nullable
 @Deprecated
public String getDescription()

Deprecated. This method will be removed with the next major SDK update.

of

public static SetDescription of(@Nullable
                                String description)

Deprecated.

Creates a new update action from the given parameters.

Parameters:

description - the description property ShippingMethod.getDescription().

Returns:

the SetDescription update action.

ofUnset

public static SetDescription ofUnset()

Deprecated.

Creates a new update action to unset the description property.

Returns:

the SetDescription update action.