Package com.commercetools.api.models.me

Interface MyBusinessUnitSetAddressCustomTypeAction

All Superinterfaces:

MyBusinessUnitUpdateAction

All Known Implementing Classes:

MyBusinessUnitSetAddressCustomTypeActionImpl

public interface MyBusinessUnitSetAddressCustomTypeAction
extends MyBusinessUnitUpdateAction

Adding or updating a Custom Type to an Address of a Business Unit generates the BusinessUnitAddressCustomTypeSet Message, and removing one generates the BusinessUnitAddressCustomTypeRemoved Message.

Example to create an instance using the builder pattern

     MyBusinessUnitSetAddressCustomTypeAction myBusinessUnitSetAddressCustomTypeAction = MyBusinessUnitSetAddressCustomTypeAction.builder()
             .addressId("{addressId}")
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SET_ADDRESS_CUSTOM_TYPE	discriminator value for MyBusinessUnitSetAddressCustomTypeAction

Method Summary

Modifier and Type	Method	Description
static MyBusinessUnitSetAddressCustomTypeActionBuilder	builder()	builder factory method for MyBusinessUnitSetAddressCustomTypeAction
static MyBusinessUnitSetAddressCustomTypeActionBuilder	builder(MyBusinessUnitSetAddressCustomTypeAction template)	create builder for MyBusinessUnitSetAddressCustomTypeAction instance
static MyBusinessUnitSetAddressCustomTypeAction	deepCopy(MyBusinessUnitSetAddressCustomTypeAction template)	factory method to create a deep copy of MyBusinessUnitSetAddressCustomTypeAction
@NotNull String	getAddressId()	ID of the address to be extended.
@Valid FieldContainer	getFields()	Sets the Custom Fields fields for the address.
@Valid TypeResourceIdentifier	getType()	Defines the Type that extends the address with Custom Fields.
static MyBusinessUnitSetAddressCustomTypeAction	of()	factory method
static MyBusinessUnitSetAddressCustomTypeAction	of(MyBusinessUnitSetAddressCustomTypeAction template)	factory method to create a shallow copy MyBusinessUnitSetAddressCustomTypeAction
void	setAddressId(String addressId)	ID of the address to be extended.
void	setFields(FieldContainer fields)	Sets the Custom Fields fields for the address.
void	setType(TypeResourceIdentifier type)	Defines the Type that extends the address with Custom Fields.
static com.fasterxml.jackson.core.type.TypeReference<MyBusinessUnitSetAddressCustomTypeAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withMyBusinessUnitSetAddressCustomTypeAction(Function<MyBusinessUnitSetAddressCustomTypeAction,T> helper)	accessor map function

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

getAction, withMyBusinessUnitUpdateAction

Field Details

SET_ADDRESS_CUSTOM_TYPE

static final String SET_ADDRESS_CUSTOM_TYPE

discriminator value for MyBusinessUnitSetAddressCustomTypeAction

See Also:

• Constant Field Values

Method Details

getType

@Valid
@Valid TypeResourceIdentifier getType()

Defines the Type that extends the address with Custom Fields. If absent, any existing Type and Custom Fields are removed from the address.

Returns:

type

getFields

@Valid
@Valid FieldContainer getFields()

Sets the Custom Fields fields for the address.

Returns:

fields

getAddressId

@NotNull
@NotNull String getAddressId()

ID of the address to be extended.

Returns:

addressId

setType

void setType(TypeResourceIdentifier type)

Defines the Type that extends the address with Custom Fields. If absent, any existing Type and Custom Fields are removed from the address.

Parameters:

type - value to be set

setFields

void setFields(FieldContainer fields)

Sets the Custom Fields fields for the address.

Parameters:

fields - value to be set

setAddressId

void setAddressId(String addressId)

ID of the address to be extended.

Parameters:

addressId - value to be set

of

static MyBusinessUnitSetAddressCustomTypeAction of()

factory method

Returns:

instance of MyBusinessUnitSetAddressCustomTypeAction

of

static MyBusinessUnitSetAddressCustomTypeAction of(MyBusinessUnitSetAddressCustomTypeAction template)

factory method to create a shallow copy MyBusinessUnitSetAddressCustomTypeAction

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static MyBusinessUnitSetAddressCustomTypeAction deepCopy(@Nullable
 MyBusinessUnitSetAddressCustomTypeAction template)

factory method to create a deep copy of MyBusinessUnitSetAddressCustomTypeAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static MyBusinessUnitSetAddressCustomTypeActionBuilder builder()

builder factory method for MyBusinessUnitSetAddressCustomTypeAction

Returns:

builder

builder

static MyBusinessUnitSetAddressCustomTypeActionBuilder builder(MyBusinessUnitSetAddressCustomTypeAction template)

create builder for MyBusinessUnitSetAddressCustomTypeAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withMyBusinessUnitSetAddressCustomTypeAction

default <T> T withMyBusinessUnitSetAddressCustomTypeAction(Function<MyBusinessUnitSetAddressCustomTypeAction,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<MyBusinessUnitSetAddressCustomTypeAction> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference