Package com.commercetools.api.models.payment

Interface PaymentSetMethodInfoCustomFieldAction

All Superinterfaces:

PaymentUpdateAction, ResourceUpdateAction<PaymentUpdateAction>

public interface PaymentSetMethodInfoCustomFieldAction
extends PaymentUpdateAction

Adding a Custom Field to a PaymentMethodInfo generates the PaymentMethodInfoCustomFieldAdded Message, removing one generates the PaymentMethodInfoCustomFieldRemoved Message, and updating an existing one generates the PaymentMethodInfoCustomFieldChanged Message.

Example to create an instance using the builder pattern

     PaymentSetMethodInfoCustomFieldAction paymentSetMethodInfoCustomFieldAction = PaymentSetMethodInfoCustomFieldAction.builder()
             .name("{name}")
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SET_METHOD_INFO_CUSTOM_FIELD	discriminator value for PaymentSetMethodInfoCustomFieldAction

Method Summary

Modifier and Type	Method	Description
static PaymentSetMethodInfoCustomFieldActionBuilder	builder()	builder factory method for PaymentSetMethodInfoCustomFieldAction
static PaymentSetMethodInfoCustomFieldActionBuilder	builder(PaymentSetMethodInfoCustomFieldAction template)	create builder for PaymentSetMethodInfoCustomFieldAction instance
PaymentSetMethodInfoCustomFieldAction	copyDeep()
static PaymentSetMethodInfoCustomFieldAction	deepCopy(PaymentSetMethodInfoCustomFieldAction template)	factory method to create a deep copy of PaymentSetMethodInfoCustomFieldAction
@NotNull String	getName()	Name of the Custom Field.
Object	getValue()	If value is absent or null, this field will be removed if it exists.
static PaymentSetMethodInfoCustomFieldAction	of()	factory method
static PaymentSetMethodInfoCustomFieldAction	of(PaymentSetMethodInfoCustomFieldAction template)	factory method to create a shallow copy PaymentSetMethodInfoCustomFieldAction
void	setName(String name)	Name of the Custom Field.
void	setValue(Object value)	If value is absent or null, this field will be removed if it exists.
static com.fasterxml.jackson.core.type.TypeReference<PaymentSetMethodInfoCustomFieldAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withPaymentSetMethodInfoCustomFieldAction(Function<PaymentSetMethodInfoCustomFieldAction,T> helper)	accessor map function

Methods inherited from interface com.commercetools.api.models.payment.PaymentUpdateAction

getAction, withPaymentUpdateAction

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

get

Field Details

SET_METHOD_INFO_CUSTOM_FIELD

static final String SET_METHOD_INFO_CUSTOM_FIELD

discriminator value for PaymentSetMethodInfoCustomFieldAction

See Also:

• Constant Field Values

Method Details

getName

@NotNull
@NotNull String getName()

Name of the Custom Field.

Returns:

name

getValue

Object getValue()

If value is absent or null, this field will be removed if it exists. If value is provided, it is set for the field defined by name. Trying to remove a field that does not exist will fail with an InvalidOperation error.

Returns:

value

setName

void setName(String name)

Name of the Custom Field.

Parameters:

name - value to be set

setValue

void setValue(Object value)

If value is absent or null, this field will be removed if it exists. If value is provided, it is set for the field defined by name. Trying to remove a field that does not exist will fail with an InvalidOperation error.

Parameters:

value - value to be set

of

static PaymentSetMethodInfoCustomFieldAction of()

factory method

Returns:

instance of PaymentSetMethodInfoCustomFieldAction

of

static PaymentSetMethodInfoCustomFieldAction of(PaymentSetMethodInfoCustomFieldAction template)

factory method to create a shallow copy PaymentSetMethodInfoCustomFieldAction

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

PaymentSetMethodInfoCustomFieldAction copyDeep()

Specified by:

copyDeep in interface PaymentUpdateAction

deepCopy

@Nullable
static PaymentSetMethodInfoCustomFieldAction deepCopy(@Nullable
 PaymentSetMethodInfoCustomFieldAction template)

factory method to create a deep copy of PaymentSetMethodInfoCustomFieldAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static PaymentSetMethodInfoCustomFieldActionBuilder builder()

builder factory method for PaymentSetMethodInfoCustomFieldAction

Returns:

builder

builder

static PaymentSetMethodInfoCustomFieldActionBuilder builder(PaymentSetMethodInfoCustomFieldAction template)

create builder for PaymentSetMethodInfoCustomFieldAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withPaymentSetMethodInfoCustomFieldAction

default <T> T withPaymentSetMethodInfoCustomFieldAction(Function<PaymentSetMethodInfoCustomFieldAction,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<PaymentSetMethodInfoCustomFieldAction> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference