Package com.commercetools.api.models.payment

Interface PaymentSetCustomFieldAction

All Superinterfaces:

PaymentUpdateAction, ResourceUpdateAction<PaymentUpdateAction>

All Known Implementing Classes:

PaymentSetCustomFieldActionImpl

public interface PaymentSetCustomFieldAction
extends PaymentUpdateAction

PaymentSetCustomFieldAction Example to create an instance using the builder pattern

     PaymentSetCustomFieldAction paymentSetCustomFieldAction = PaymentSetCustomFieldAction.builder()
             .name("{name}")
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SET_CUSTOM_FIELD	discriminator value for PaymentSetCustomFieldAction

Method Summary

Modifier and Type	Method	Description
static PaymentSetCustomFieldActionBuilder	builder()	builder factory method for PaymentSetCustomFieldAction
static PaymentSetCustomFieldActionBuilder	builder(PaymentSetCustomFieldAction template)	create builder for PaymentSetCustomFieldAction instance
static PaymentSetCustomFieldAction	deepCopy(PaymentSetCustomFieldAction template)	factory method to create a deep copy of PaymentSetCustomFieldAction
@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 PaymentSetCustomFieldAction	of()	factory method
static PaymentSetCustomFieldAction	of(PaymentSetCustomFieldAction template)	factory method to create a shallow copy PaymentSetCustomFieldAction
static PaymentSetCustomFieldAction	ofUnset(String name)
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<PaymentSetCustomFieldAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withPaymentSetCustomFieldAction(Function<PaymentSetCustomFieldAction,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_CUSTOM_FIELD

static final String SET_CUSTOM_FIELD

discriminator value for PaymentSetCustomFieldAction

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. Removing a field that does not exist returns an InvalidOperation error. If value is provided, it is set for the field defined by name.

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. Removing a field that does not exist returns an InvalidOperation error. If value is provided, it is set for the field defined by name.

Parameters:

value - value to be set

of

static PaymentSetCustomFieldAction of()

factory method

Returns:

instance of PaymentSetCustomFieldAction

of

static PaymentSetCustomFieldAction of(PaymentSetCustomFieldAction template)

factory method to create a shallow copy PaymentSetCustomFieldAction

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static PaymentSetCustomFieldAction deepCopy(@Nullable
 PaymentSetCustomFieldAction template)

factory method to create a deep copy of PaymentSetCustomFieldAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static PaymentSetCustomFieldActionBuilder builder()

builder factory method for PaymentSetCustomFieldAction

Returns:

builder

builder

static PaymentSetCustomFieldActionBuilder builder(PaymentSetCustomFieldAction template)

create builder for PaymentSetCustomFieldAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withPaymentSetCustomFieldAction

default <T> T withPaymentSetCustomFieldAction(Function<PaymentSetCustomFieldAction,T> helper)

accessor map function

Type Parameters:

T - mapped type

Parameters:

helper - function to map the object

Returns:

mapped value

ofUnset

static PaymentSetCustomFieldAction ofUnset(String name)

typeReference

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

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference