Package com.commercetools.api.models.me

Interface MyBusinessUnitSetAddressCustomFieldAction

All Superinterfaces:

MyBusinessUnitUpdateAction

public interface MyBusinessUnitSetAddressCustomFieldAction
extends MyBusinessUnitUpdateAction

Adding a Custom Field to an Address of a Business Unit generates the BusinessUnitAddressCustomFieldAdded Message, removing one generates the BusinessUnitAddressCustomFieldRemoved Message, and updating an existing one generates the BusinessUnitAddressCustomFieldChanged Message.

Example to create an instance using the builder pattern

     MyBusinessUnitSetAddressCustomFieldAction myBusinessUnitSetAddressCustomFieldAction = MyBusinessUnitSetAddressCustomFieldAction.builder()
             .addressId("{addressId}")
             .name("{name}")
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SET_ADDRESS_CUSTOM_FIELD	discriminator value for MyBusinessUnitSetAddressCustomFieldAction

Method Summary

Modifier and Type	Method	Description
static MyBusinessUnitSetAddressCustomFieldActionBuilder	builder()	builder factory method for MyBusinessUnitSetAddressCustomFieldAction
static MyBusinessUnitSetAddressCustomFieldActionBuilder	builder(MyBusinessUnitSetAddressCustomFieldAction template)	create builder for MyBusinessUnitSetAddressCustomFieldAction instance
MyBusinessUnitSetAddressCustomFieldAction	copyDeep()
static MyBusinessUnitSetAddressCustomFieldAction	deepCopy(MyBusinessUnitSetAddressCustomFieldAction template)	factory method to create a deep copy of MyBusinessUnitSetAddressCustomFieldAction
@NotNull String	getAddressId()	ID of the address to be extended.
@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 MyBusinessUnitSetAddressCustomFieldAction	of()	factory method
static MyBusinessUnitSetAddressCustomFieldAction	of(MyBusinessUnitSetAddressCustomFieldAction template)	factory method to create a shallow copy MyBusinessUnitSetAddressCustomFieldAction
void	setAddressId(String addressId)	ID of the address to be extended.
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<MyBusinessUnitSetAddressCustomFieldAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withMyBusinessUnitSetAddressCustomFieldAction(Function<MyBusinessUnitSetAddressCustomFieldAction,T> helper)	accessor map function

Methods inherited from interface com.commercetools.api.models.me.MyBusinessUnitUpdateAction

getAction, withMyBusinessUnitUpdateAction

Field Details

SET_ADDRESS_CUSTOM_FIELD

static final String SET_ADDRESS_CUSTOM_FIELD

discriminator value for MyBusinessUnitSetAddressCustomFieldAction

See Also:

• Constant Field Values

Method Details

getAddressId

@NotNull
@NotNull String getAddressId()

ID of the address to be extended.

Returns:

addressId

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. Trying to remove a field that does not exist will fail with an InvalidOperation error. If value is provided, it is set for the field defined by name.

Returns:

value

setAddressId

void setAddressId(String addressId)

ID of the address to be extended.

Parameters:

addressId - value to be set

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. Trying to remove a field that does not exist will fail with an InvalidOperation error. If value is provided, it is set for the field defined by name.

Parameters:

value - value to be set

of

static MyBusinessUnitSetAddressCustomFieldAction of()

factory method

Returns:

instance of MyBusinessUnitSetAddressCustomFieldAction

of

static MyBusinessUnitSetAddressCustomFieldAction of(MyBusinessUnitSetAddressCustomFieldAction template)

factory method to create a shallow copy MyBusinessUnitSetAddressCustomFieldAction

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

MyBusinessUnitSetAddressCustomFieldAction copyDeep()

Specified by:

copyDeep in interface MyBusinessUnitUpdateAction

deepCopy

@Nullable
static MyBusinessUnitSetAddressCustomFieldAction deepCopy(@Nullable
 MyBusinessUnitSetAddressCustomFieldAction template)

factory method to create a deep copy of MyBusinessUnitSetAddressCustomFieldAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static MyBusinessUnitSetAddressCustomFieldActionBuilder builder()

builder factory method for MyBusinessUnitSetAddressCustomFieldAction

Returns:

builder

builder

static MyBusinessUnitSetAddressCustomFieldActionBuilder builder(MyBusinessUnitSetAddressCustomFieldAction template)

create builder for MyBusinessUnitSetAddressCustomFieldAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withMyBusinessUnitSetAddressCustomFieldAction

default <T> T withMyBusinessUnitSetAddressCustomFieldAction(Function<MyBusinessUnitSetAddressCustomFieldAction,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<MyBusinessUnitSetAddressCustomFieldAction> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference