Package com.commercetools.api.models.business_unit

Interface BusinessUnitRemoveAddressAction

All Superinterfaces:

BusinessUnitUpdateAction, ResourceUpdateAction<BusinessUnitUpdateAction>

All Known Implementing Classes:

BusinessUnitRemoveAddressActionImpl

public interface BusinessUnitRemoveAddressAction
extends BusinessUnitUpdateAction

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

Example to create an instance using the builder pattern

     BusinessUnitRemoveAddressAction businessUnitRemoveAddressAction = BusinessUnitRemoveAddressAction.builder()
             .build()
 

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
static BusinessUnitRemoveAddressActionBuilder	builder()	builder factory method for BusinessUnitRemoveAddressAction
static BusinessUnitRemoveAddressActionBuilder	builder(BusinessUnitRemoveAddressAction template)	create builder for BusinessUnitRemoveAddressAction instance
static BusinessUnitRemoveAddressAction	deepCopy(BusinessUnitRemoveAddressAction template)	factory method to create a deep copy of BusinessUnitRemoveAddressAction
String	getAddressId()	ID of the address to be removed.
String	getAddressKey()	Key of the address to be removed.
static BusinessUnitRemoveAddressAction	of()	factory method
static BusinessUnitRemoveAddressAction	of(BusinessUnitRemoveAddressAction template)	factory method to create a shallow copy BusinessUnitRemoveAddressAction
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<BusinessUnitRemoveAddressAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withBusinessUnitRemoveAddressAction(Function<BusinessUnitRemoveAddressAction,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_ADDRESS

static final String REMOVE_ADDRESS

discriminator value for BusinessUnitRemoveAddressAction

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 BusinessUnitRemoveAddressAction of()

factory method

Returns:

instance of BusinessUnitRemoveAddressAction

of

static BusinessUnitRemoveAddressAction of(BusinessUnitRemoveAddressAction template)

factory method to create a shallow copy BusinessUnitRemoveAddressAction

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static BusinessUnitRemoveAddressAction deepCopy(@Nullable
 BusinessUnitRemoveAddressAction template)

factory method to create a deep copy of BusinessUnitRemoveAddressAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static BusinessUnitRemoveAddressActionBuilder builder()

builder factory method for BusinessUnitRemoveAddressAction

Returns:

builder

builder

static BusinessUnitRemoveAddressActionBuilder builder(BusinessUnitRemoveAddressAction template)

create builder for BusinessUnitRemoveAddressAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withBusinessUnitRemoveAddressAction

default <T> T withBusinessUnitRemoveAddressAction(Function<BusinessUnitRemoveAddressAction,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<BusinessUnitRemoveAddressAction> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference