Package com.commercetools.api.models.business_unit

Interface BusinessUnitRemoveShippingAddressIdAction

All Superinterfaces:

BusinessUnitUpdateAction, ResourceUpdateAction<BusinessUnitUpdateAction>

public interface BusinessUnitRemoveShippingAddressIdAction
extends BusinessUnitUpdateAction

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

Example to create an instance using the builder pattern

     BusinessUnitRemoveShippingAddressIdAction businessUnitRemoveShippingAddressIdAction = BusinessUnitRemoveShippingAddressIdAction.builder()
             .build()
 

Field Summary

Fields

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

Method Summary

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

Methods inherited from interface com.commercetools.api.models.business_unit.BusinessUnitUpdateAction

getAction, withBusinessUnitUpdateAction

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

get

Field Details

REMOVE_SHIPPING_ADDRESS_ID

static final String REMOVE_SHIPPING_ADDRESS_ID

discriminator value for BusinessUnitRemoveShippingAddressIdAction

See Also:

• Constant Field Values

Method Details

getAddressId

String getAddressId()

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

Returns:

addressId

getAddressKey

String getAddressKey()

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

Returns:

addressKey

setAddressId

void setAddressId(String addressId)

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

Parameters:

addressId - value to be set

setAddressKey

void setAddressKey(String addressKey)

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

Parameters:

addressKey - value to be set

of

static BusinessUnitRemoveShippingAddressIdAction of()

factory method

Returns:

instance of BusinessUnitRemoveShippingAddressIdAction

of

static BusinessUnitRemoveShippingAddressIdAction of(BusinessUnitRemoveShippingAddressIdAction template)

factory method to create a shallow copy BusinessUnitRemoveShippingAddressIdAction

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static BusinessUnitRemoveShippingAddressIdAction deepCopy(@Nullable
 BusinessUnitRemoveShippingAddressIdAction template)

factory method to create a deep copy of BusinessUnitRemoveShippingAddressIdAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static BusinessUnitRemoveShippingAddressIdActionBuilder builder()

builder factory method for BusinessUnitRemoveShippingAddressIdAction

Returns:

builder

builder

static BusinessUnitRemoveShippingAddressIdActionBuilder builder(BusinessUnitRemoveShippingAddressIdAction template)

create builder for BusinessUnitRemoveShippingAddressIdAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withBusinessUnitRemoveShippingAddressIdAction

default <T> T withBusinessUnitRemoveShippingAddressIdAction(Function<BusinessUnitRemoveShippingAddressIdAction,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<BusinessUnitRemoveShippingAddressIdAction> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference