io.sphere.sdk.payments.commands.updateactions

Class SetKey

java.lang.Object

io.sphere.sdk.models.Base

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

io.sphere.sdk.payments.commands.updateactions.SetKey

All Implemented Interfaces:

UpdateAction<Payment>

@Generated(value="io.sphere.sdk.annotations.processors.generators.UpdateActionsGenerator",
           comments="Generated from: io.sphere.sdk.payments.Payment")
public final class SetKey
extends UpdateActionImpl<Payment>

Sets the key property of a Payment.

withPayment(client(), (Payment payment) -> {
    final String newKey = randomKey();
    final PaymentUpdateCommand cmd = PaymentUpdateCommand.of(payment, SetKey.of(newKey));
    final Payment updatedPayment = client().executeBlocking(cmd);

    assertThat(updatedPayment.getKey()).isEqualTo(newKey);

    return updatedPayment;
});
See the test code.

See Also:

Payment.getKey()

Method Summary

Modifier and Type	Method and Description
String	getKey()
static SetKey	of(String key) Creates a new update action from the given parameters.
static SetKey	ofUnset() Creates a new update action to unset the key 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

getKey

@Nullable
public String getKey()

of

public static SetKey of(@Nullable
                        String key)

Creates a new update action from the given parameters.

Parameters:

key - the key property Payment.getKey().

Returns:

the SetKey update action.

ofUnset

public static SetKey ofUnset()

Creates a new update action to unset the key property.

Returns:

the SetKey update action.