Package com.commercetools.api.models.message

Interface PaymentMethodCustomFieldAddedMessagePayload

All Superinterfaces:

MessagePayload, MessagePayloadMixin

public interface PaymentMethodCustomFieldAddedMessagePayload
extends MessagePayload

Generated after adding a Custom Field to a Payment Method using the Set CustomField update action. If a Custom Field already exists with the same name, a PaymentMethodCustomFieldChanged Message is generated instead.

Example to create an instance using the builder pattern

     PaymentMethodCustomFieldAddedMessagePayload paymentMethodCustomFieldAddedMessagePayload = PaymentMethodCustomFieldAddedMessagePayload.builder()
             .name("{name}")
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PAYMENT_METHOD_CUSTOM_FIELD_ADDED	discriminator value for PaymentMethodCustomFieldAddedMessagePayload

Method Summary

Modifier and Type	Method	Description
static PaymentMethodCustomFieldAddedMessagePayloadBuilder	builder()	builder factory method for PaymentMethodCustomFieldAddedMessagePayload
static PaymentMethodCustomFieldAddedMessagePayloadBuilder	builder(PaymentMethodCustomFieldAddedMessagePayload template)	create builder for PaymentMethodCustomFieldAddedMessagePayload instance
PaymentMethodCustomFieldAddedMessagePayload	copyDeep()
static PaymentMethodCustomFieldAddedMessagePayload	deepCopy(PaymentMethodCustomFieldAddedMessagePayload template)	factory method to create a deep copy of PaymentMethodCustomFieldAddedMessagePayload
@NotNull String	getName()	Name of the Custom Field that was added.
@NotNull Object	getValue()	The added CustomFieldValue based on the FieldType.
static PaymentMethodCustomFieldAddedMessagePayload	of()	factory method
static PaymentMethodCustomFieldAddedMessagePayload	of(PaymentMethodCustomFieldAddedMessagePayload template)	factory method to create a shallow copy PaymentMethodCustomFieldAddedMessagePayload
void	setName(String name)	Name of the Custom Field that was added.
void	setValue(Object value)	The added CustomFieldValue based on the FieldType.
static com.fasterxml.jackson.core.type.TypeReference<PaymentMethodCustomFieldAddedMessagePayload>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withPaymentMethodCustomFieldAddedMessagePayload(Function<PaymentMethodCustomFieldAddedMessagePayload,T> helper)	accessor map function

Methods inherited from interface com.commercetools.api.models.message.MessagePayload

getType, withMessagePayload

Methods inherited from interface com.commercetools.api.models.message.MessagePayloadMixin

as

Field Details

PAYMENT_METHOD_CUSTOM_FIELD_ADDED

static final String PAYMENT_METHOD_CUSTOM_FIELD_ADDED

discriminator value for PaymentMethodCustomFieldAddedMessagePayload

See Also:

• Constant Field Values

Method Details

getName

@NotNull
@NotNull String getName()

Name of the Custom Field that was added.

Returns:

name

getValue

@NotNull
@NotNull Object getValue()

The added CustomFieldValue based on the FieldType.

Returns:

value

setName

void setName(String name)

Name of the Custom Field that was added.

Parameters:

name - value to be set

setValue

void setValue(Object value)

The added CustomFieldValue based on the FieldType.

Parameters:

value - value to be set

of

static PaymentMethodCustomFieldAddedMessagePayload of()

factory method

Returns:

instance of PaymentMethodCustomFieldAddedMessagePayload

of

static PaymentMethodCustomFieldAddedMessagePayload of(PaymentMethodCustomFieldAddedMessagePayload template)

factory method to create a shallow copy PaymentMethodCustomFieldAddedMessagePayload

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

PaymentMethodCustomFieldAddedMessagePayload copyDeep()

Specified by:

copyDeep in interface MessagePayload

deepCopy

@Nullable
static PaymentMethodCustomFieldAddedMessagePayload deepCopy(@Nullable
 PaymentMethodCustomFieldAddedMessagePayload template)

factory method to create a deep copy of PaymentMethodCustomFieldAddedMessagePayload

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static PaymentMethodCustomFieldAddedMessagePayloadBuilder builder()

builder factory method for PaymentMethodCustomFieldAddedMessagePayload

Returns:

builder

builder

static PaymentMethodCustomFieldAddedMessagePayloadBuilder builder(PaymentMethodCustomFieldAddedMessagePayload template)

create builder for PaymentMethodCustomFieldAddedMessagePayload instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withPaymentMethodCustomFieldAddedMessagePayload

default <T> T withPaymentMethodCustomFieldAddedMessagePayload(Function<PaymentMethodCustomFieldAddedMessagePayload,T> helper)

accessor map function

Type Parameters:

T - mapped type

Parameters:

helper - function to map the object

Returns:

mapped value

typeReference

static com.fasterxml.jackson.core.type.TypeReference<PaymentMethodCustomFieldAddedMessagePayload> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference