Package com.commercetools.api.models.customer

Interface CustomerSetAddressCustomTypeAction

All Superinterfaces:

CustomerUpdateAction, ResourceUpdateAction<CustomerUpdateAction>

public interface CustomerSetAddressCustomTypeAction
extends CustomerUpdateAction

Adding or updating a Custom Type on an Address of a Customer generates the CustomerAddressCustomTypeSet Message, and removing one generates the CustomerAddressCustomTypeRemoved Message.

Example to create an instance using the builder pattern

     CustomerSetAddressCustomTypeAction customerSetAddressCustomTypeAction = CustomerSetAddressCustomTypeAction.builder()
             .addressId("{addressId}")
             .build()
 

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
static CustomerSetAddressCustomTypeActionBuilder	builder()	builder factory method for CustomerSetAddressCustomTypeAction
static CustomerSetAddressCustomTypeActionBuilder	builder(CustomerSetAddressCustomTypeAction template)	create builder for CustomerSetAddressCustomTypeAction instance
CustomerSetAddressCustomTypeAction	copyDeep()
static CustomerSetAddressCustomTypeAction	deepCopy(CustomerSetAddressCustomTypeAction template)	factory method to create a deep copy of CustomerSetAddressCustomTypeAction
@NotNull String	getAddressId()	User-defined unique identifier of the Address to be updated.
@Valid FieldContainer	getFields()	Object containing the Custom Fields fields for the address.
@Valid TypeResourceIdentifier	getType()	Defines the Type that extends the address with Custom Fields.
static CustomerSetAddressCustomTypeAction	of()	factory method
static CustomerSetAddressCustomTypeAction	of(CustomerSetAddressCustomTypeAction template)	factory method to create a shallow copy CustomerSetAddressCustomTypeAction
void	setAddressId(String addressId)	User-defined unique identifier of the Address to be updated.
void	setFields(FieldContainer fields)	Object containing 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<CustomerSetAddressCustomTypeAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withCustomerSetAddressCustomTypeAction(Function<CustomerSetAddressCustomTypeAction,T> helper)	accessor map function

Methods inherited from interface com.commercetools.api.models.customer.CustomerUpdateAction

getAction, withCustomerUpdateAction

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

get

Field Details

SET_ADDRESS_CUSTOM_TYPE

static final String SET_ADDRESS_CUSTOM_TYPE

discriminator value for CustomerSetAddressCustomTypeAction

See Also:

• Constant Field Values

Method Details

getAddressId

@NotNull
@NotNull String getAddressId()

User-defined unique identifier of the Address to be updated.

Returns:

addressId

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

Object containing the Custom Fields fields for the address.

Required if at least one Custom Field is defined as required in the fieldDefinitions of the referenced Type.

Returns:

fields

setAddressId

void setAddressId(String addressId)

User-defined unique identifier of the Address to be updated.

Parameters:

addressId - value to be set

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)

Object containing the Custom Fields fields for the address.

Required if at least one Custom Field is defined as required in the fieldDefinitions of the referenced Type.

Parameters:

fields - value to be set

of

static CustomerSetAddressCustomTypeAction of()

factory method

Returns:

instance of CustomerSetAddressCustomTypeAction

of

static CustomerSetAddressCustomTypeAction of(CustomerSetAddressCustomTypeAction template)

factory method to create a shallow copy CustomerSetAddressCustomTypeAction

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

CustomerSetAddressCustomTypeAction copyDeep()

Specified by:

copyDeep in interface CustomerUpdateAction

deepCopy

@Nullable
static CustomerSetAddressCustomTypeAction deepCopy(@Nullable
 CustomerSetAddressCustomTypeAction template)

factory method to create a deep copy of CustomerSetAddressCustomTypeAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static CustomerSetAddressCustomTypeActionBuilder builder()

builder factory method for CustomerSetAddressCustomTypeAction

Returns:

builder

builder

static CustomerSetAddressCustomTypeActionBuilder builder(CustomerSetAddressCustomTypeAction template)

create builder for CustomerSetAddressCustomTypeAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withCustomerSetAddressCustomTypeAction

default <T> T withCustomerSetAddressCustomTypeAction(Function<CustomerSetAddressCustomTypeAction,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<CustomerSetAddressCustomTypeAction> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference