Package com.commercetools.api.models.me

Interface MyBusinessUnitRemoveShippingAddressIdAction

All Superinterfaces:

MyBusinessUnitUpdateAction

All Known Implementing Classes:

MyBusinessUnitRemoveShippingAddressIdActionImpl

public interface MyBusinessUnitRemoveShippingAddressIdAction
extends MyBusinessUnitUpdateAction

Removing a shipping address from a Business Unit generates a BusinessUnitShippingAddressRemoved Message.

Example to create an instance using the builder pattern

     MyBusinessUnitRemoveShippingAddressIdAction myBusinessUnitRemoveShippingAddressIdAction = MyBusinessUnitRemoveShippingAddressIdAction.builder()
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	REMOVE_SHIPPING_ADDRESS_ID	discriminator value for MyBusinessUnitRemoveShippingAddressIdAction

Method Summary

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

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

getAction, withMyBusinessUnitUpdateAction

Field Details

REMOVE_SHIPPING_ADDRESS_ID

static final String REMOVE_SHIPPING_ADDRESS_ID

discriminator value for MyBusinessUnitRemoveShippingAddressIdAction

See Also:

• Constant Field Values

Method Details

getAddressId

String getAddressId()

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

Returns:

addressId

getAddressKey

String getAddressKey()

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

Returns:

addressKey

setAddressId

void setAddressId(String addressId)

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

Parameters:

addressId - value to be set

setAddressKey

void setAddressKey(String addressKey)

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

Parameters:

addressKey - value to be set

of

static MyBusinessUnitRemoveShippingAddressIdAction of()

factory method

Returns:

instance of MyBusinessUnitRemoveShippingAddressIdAction

of

static MyBusinessUnitRemoveShippingAddressIdAction of(MyBusinessUnitRemoveShippingAddressIdAction template)

factory method to create a shallow copy MyBusinessUnitRemoveShippingAddressIdAction

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static MyBusinessUnitRemoveShippingAddressIdAction deepCopy(@Nullable
 MyBusinessUnitRemoveShippingAddressIdAction template)

factory method to create a deep copy of MyBusinessUnitRemoveShippingAddressIdAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static MyBusinessUnitRemoveShippingAddressIdActionBuilder builder()

builder factory method for MyBusinessUnitRemoveShippingAddressIdAction

Returns:

builder

builder

static MyBusinessUnitRemoveShippingAddressIdActionBuilder builder(MyBusinessUnitRemoveShippingAddressIdAction template)

create builder for MyBusinessUnitRemoveShippingAddressIdAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withMyBusinessUnitRemoveShippingAddressIdAction

default <T> T withMyBusinessUnitRemoveShippingAddressIdAction(Function<MyBusinessUnitRemoveShippingAddressIdAction,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<MyBusinessUnitRemoveShippingAddressIdAction> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference