io.sphere.sdk.payments.commands.updateactions

Class SetExternalId

java.lang.Object

io.sphere.sdk.models.Base

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

io.sphere.sdk.payments.commands.updateactions.SetExternalId

All Implemented Interfaces:

UpdateAction<Payment>

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.payments.Payment")
 @Deprecated
public final class SetExternalId
extends UpdateActionImpl<Payment>

Sets the externalId property of a Payment.

withPayment(client(), payment -> {
        final String externalId = randomKey();

        final Payment updatedPayment = client().executeBlocking(PaymentUpdateCommand.of(payment, asList(SetExternalId.of(externalId))));

        assertThat(updatedPayment.getExternalId()).isEqualTo(externalId);

        return updatedPayment;
    });
See the test code.

See Also:

Payment.getExternalId()

Method Summary

Modifier and Type	Method and Description
String	getExternalId() Deprecated. This method will be removed with the next major SDK update.
static SetExternalId	of(String externalId) Deprecated. Creates a new update action from the given parameters.
static SetExternalId	ofUnset() Deprecated. Creates a new update action to unset the externalId 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

getExternalId

@Nullable
 @Deprecated
public String getExternalId()

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

of

public static SetExternalId of(@Nullable
                               String externalId)

Deprecated.

Creates a new update action from the given parameters.

Parameters:

externalId - the externalId property Payment.getExternalId().

Returns:

the SetExternalId update action.

ofUnset

public static SetExternalId ofUnset()

Deprecated.

Creates a new update action to unset the externalId property.

Returns:

the SetExternalId update action.