Package com.commercetools.api.models.me

Interface MyCustomerChangeAddressAction

All Superinterfaces:

MyCustomerUpdateAction, ResourceUpdateAction<MyCustomerUpdateAction>

public interface MyCustomerChangeAddressAction
extends MyCustomerUpdateAction

Changing an address of the Customer produces the CustomerAddressChanged Message.

Either addressId or addressKey is required.

Example to create an instance using the builder pattern

     MyCustomerChangeAddressAction myCustomerChangeAddressAction = MyCustomerChangeAddressAction.builder()
             .address(addressBuilder -> addressBuilder)
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CHANGE_ADDRESS	discriminator value for MyCustomerChangeAddressAction

Method Summary

Modifier and Type	Method	Description
static MyCustomerChangeAddressActionBuilder	builder()	builder factory method for MyCustomerChangeAddressAction
static MyCustomerChangeAddressActionBuilder	builder(MyCustomerChangeAddressAction template)	create builder for MyCustomerChangeAddressAction instance
MyCustomerChangeAddressAction	copyDeep()
static MyCustomerChangeAddressAction	deepCopy(MyCustomerChangeAddressAction template)	factory method to create a deep copy of MyCustomerChangeAddressAction
@NotNull @Valid BaseAddress	getAddress()	Value to set.
String	getAddressId()	id of the Address to change.
String	getAddressKey()	key of the Address to change.
static MyCustomerChangeAddressAction	of()	factory method
static MyCustomerChangeAddressAction	of(MyCustomerChangeAddressAction template)	factory method to create a shallow copy MyCustomerChangeAddressAction
void	setAddress(BaseAddress address)	Value to set.
void	setAddressId(String addressId)	id of the Address to change.
void	setAddressKey(String addressKey)	key of the Address to change.
static com.fasterxml.jackson.core.type.TypeReference<MyCustomerChangeAddressAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withMyCustomerChangeAddressAction(Function<MyCustomerChangeAddressAction,T> helper)	accessor map function

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

getAction, withMyCustomerUpdateAction

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

get

Field Details

CHANGE_ADDRESS

static final String CHANGE_ADDRESS

discriminator value for MyCustomerChangeAddressAction

See Also:

• Constant Field Values

Method Details

getAddressId

String getAddressId()

id of the Address to change.

Returns:

addressId

getAddressKey

String getAddressKey()

key of the Address to change.

Returns:

addressKey

getAddress

@NotNull
@Valid
@NotNull @Valid BaseAddress getAddress()

Value to set.

Returns:

address

setAddressId

void setAddressId(String addressId)

id of the Address to change.

Parameters:

addressId - value to be set

setAddressKey

void setAddressKey(String addressKey)

key of the Address to change.

Parameters:

addressKey - value to be set

setAddress

void setAddress(BaseAddress address)

Value to set.

Parameters:

address - value to be set

of

static MyCustomerChangeAddressAction of()

factory method

Returns:

instance of MyCustomerChangeAddressAction

of

static MyCustomerChangeAddressAction of(MyCustomerChangeAddressAction template)

factory method to create a shallow copy MyCustomerChangeAddressAction

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

MyCustomerChangeAddressAction copyDeep()

Specified by:

copyDeep in interface MyCustomerUpdateAction

deepCopy

@Nullable
static MyCustomerChangeAddressAction deepCopy(@Nullable
 MyCustomerChangeAddressAction template)

factory method to create a deep copy of MyCustomerChangeAddressAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static MyCustomerChangeAddressActionBuilder builder()

builder factory method for MyCustomerChangeAddressAction

Returns:

builder

builder

static MyCustomerChangeAddressActionBuilder builder(MyCustomerChangeAddressAction template)

create builder for MyCustomerChangeAddressAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withMyCustomerChangeAddressAction

default <T> T withMyCustomerChangeAddressAction(Function<MyCustomerChangeAddressAction,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<MyCustomerChangeAddressAction> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference