Package com.commercetools.api.models.message

Interface PaymentMethodCustomFieldAddedMessage

All Superinterfaces:

BaseResource, DomainResource<Message>, Identifiable<Message>, Message, Versioned<Message>

public interface PaymentMethodCustomFieldAddedMessage
extends Message

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

     PaymentMethodCustomFieldAddedMessage paymentMethodCustomFieldAddedMessage = PaymentMethodCustomFieldAddedMessage.builder()
             .id("{id}")
             .version(0.3)
             .createdAt(ZonedDateTime.parse("2022-01-01T12:00:00.301Z"))
             .lastModifiedAt(ZonedDateTime.parse("2022-01-01T12:00:00.301Z"))
             .sequenceNumber(0.3)
             .resource(resourceBuilder -> resourceBuilder)
             .resourceVersion(0.3)
             .name("{name}")
             .build()
 

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
static PaymentMethodCustomFieldAddedMessageBuilder	builder()	builder factory method for PaymentMethodCustomFieldAddedMessage
static PaymentMethodCustomFieldAddedMessageBuilder	builder(PaymentMethodCustomFieldAddedMessage template)	create builder for PaymentMethodCustomFieldAddedMessage instance
PaymentMethodCustomFieldAddedMessage	copyDeep()
static PaymentMethodCustomFieldAddedMessage	deepCopy(PaymentMethodCustomFieldAddedMessage template)	factory method to create a deep copy of PaymentMethodCustomFieldAddedMessage
@NotNull String	getName()	Name of the Custom Field that was added.
@NotNull Object	getValue()	The added CustomFieldValue based on the FieldType.
static PaymentMethodCustomFieldAddedMessage	of()	factory method
static PaymentMethodCustomFieldAddedMessage	of(PaymentMethodCustomFieldAddedMessage template)	factory method to create a shallow copy PaymentMethodCustomFieldAddedMessage
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<PaymentMethodCustomFieldAddedMessage>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withPaymentMethodCustomFieldAddedMessage(Function<PaymentMethodCustomFieldAddedMessage,T> helper)	accessor map function

Methods inherited from interface com.commercetools.api.models.common.BaseResource

withBaseResource

Methods inherited from interface com.commercetools.api.models.DomainResource

get

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

getCreatedAt, getCreatedBy, getId, getLastModifiedAt, getLastModifiedBy, getResource, getResourceUserProvidedIdentifiers, getResourceVersion, getSequenceNumber, getType, getVersion, setCreatedAt, setCreatedBy, setId, setLastModifiedAt, setLastModifiedBy, setResource, setResourceUserProvidedIdentifiers, setResourceVersion, setSequenceNumber, setVersion, withMessage

Field Details

PAYMENT_METHOD_CUSTOM_FIELD_ADDED

static final String PAYMENT_METHOD_CUSTOM_FIELD_ADDED

discriminator value for PaymentMethodCustomFieldAddedMessage

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 PaymentMethodCustomFieldAddedMessage of()

factory method

Returns:

instance of PaymentMethodCustomFieldAddedMessage

of

static PaymentMethodCustomFieldAddedMessage of(PaymentMethodCustomFieldAddedMessage template)

factory method to create a shallow copy PaymentMethodCustomFieldAddedMessage

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

PaymentMethodCustomFieldAddedMessage copyDeep()

Specified by:

copyDeep in interface BaseResource

Specified by:

copyDeep in interface Message

deepCopy

@Nullable
static PaymentMethodCustomFieldAddedMessage deepCopy(@Nullable
 PaymentMethodCustomFieldAddedMessage template)

factory method to create a deep copy of PaymentMethodCustomFieldAddedMessage

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static PaymentMethodCustomFieldAddedMessageBuilder builder()

builder factory method for PaymentMethodCustomFieldAddedMessage

Returns:

builder

builder

static PaymentMethodCustomFieldAddedMessageBuilder builder(PaymentMethodCustomFieldAddedMessage template)

create builder for PaymentMethodCustomFieldAddedMessage instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withPaymentMethodCustomFieldAddedMessage

default <T> T withPaymentMethodCustomFieldAddedMessage(Function<PaymentMethodCustomFieldAddedMessage,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<PaymentMethodCustomFieldAddedMessage> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference