Package com.commercetools.api.models.me

Interface MyBusinessUnitRemoveAddressAction

All Superinterfaces:

MyBusinessUnitUpdateAction

All Known Implementing Classes:

MyBusinessUnitRemoveAddressActionImpl

public interface MyBusinessUnitRemoveAddressAction
extends MyBusinessUnitUpdateAction

Removing the address from a Business Unit generates the BusinessUnitAddressRemoved Message.

Example to create an instance using the builder pattern

     MyBusinessUnitRemoveAddressAction myBusinessUnitRemoveAddressAction = MyBusinessUnitRemoveAddressAction.builder()
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	REMOVE_ADDRESS	discriminator value for MyBusinessUnitRemoveAddressAction

Method Summary

Modifier and Type	Method	Description
static MyBusinessUnitRemoveAddressActionBuilder	builder()	builder factory method for MyBusinessUnitRemoveAddressAction
static MyBusinessUnitRemoveAddressActionBuilder	builder(MyBusinessUnitRemoveAddressAction template)	create builder for MyBusinessUnitRemoveAddressAction instance
static MyBusinessUnitRemoveAddressAction	deepCopy(MyBusinessUnitRemoveAddressAction template)	factory method to create a deep copy of MyBusinessUnitRemoveAddressAction
String	getAddressId()	ID of the address to be removed.
String	getAddressKey()	Key of the address to be removed.
static MyBusinessUnitRemoveAddressAction	of()	factory method
static MyBusinessUnitRemoveAddressAction	of(MyBusinessUnitRemoveAddressAction template)	factory method to create a shallow copy MyBusinessUnitRemoveAddressAction
void	setAddressId(String addressId)	ID of the address to be removed.
void	setAddressKey(String addressKey)	Key of the address to be removed.
static com.fasterxml.jackson.core.type.TypeReference<MyBusinessUnitRemoveAddressAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withMyBusinessUnitRemoveAddressAction(Function<MyBusinessUnitRemoveAddressAction,T> helper)	accessor map function

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

getAction, withMyBusinessUnitUpdateAction

Field Details

REMOVE_ADDRESS

static final String REMOVE_ADDRESS

discriminator value for MyBusinessUnitRemoveAddressAction

See Also:

• Constant Field Values

Method Details

getAddressId

String getAddressId()

ID of the address to be removed. Either addressId or addressKey is required.

Returns:

addressId

getAddressKey

String getAddressKey()

Key of the address to be removed. Either addressId or addressKey is required.

Returns:

addressKey

setAddressId

void setAddressId(String addressId)

ID of the address to be removed. Either addressId or addressKey is required.

Parameters:

addressId - value to be set

setAddressKey

void setAddressKey(String addressKey)

Key of the address to be removed. Either addressId or addressKey is required.

Parameters:

addressKey - value to be set

of

static MyBusinessUnitRemoveAddressAction of()

factory method

Returns:

instance of MyBusinessUnitRemoveAddressAction

of

static MyBusinessUnitRemoveAddressAction of(MyBusinessUnitRemoveAddressAction template)

factory method to create a shallow copy MyBusinessUnitRemoveAddressAction

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static MyBusinessUnitRemoveAddressAction deepCopy(@Nullable
 MyBusinessUnitRemoveAddressAction template)

factory method to create a deep copy of MyBusinessUnitRemoveAddressAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static MyBusinessUnitRemoveAddressActionBuilder builder()

builder factory method for MyBusinessUnitRemoveAddressAction

Returns:

builder

builder

static MyBusinessUnitRemoveAddressActionBuilder builder(MyBusinessUnitRemoveAddressAction template)

create builder for MyBusinessUnitRemoveAddressAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withMyBusinessUnitRemoveAddressAction

default <T> T withMyBusinessUnitRemoveAddressAction(Function<MyBusinessUnitRemoveAddressAction,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<MyBusinessUnitRemoveAddressAction> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference