Package com.commercetools.api.models.message

Interface CustomerShippingAddressAddedMessagePayload

All Superinterfaces:

MessagePayload, MessagePayloadMixin

public interface CustomerShippingAddressAddedMessagePayload
extends MessagePayload

Generated after a successful Add Shipping Address ID update action.

Example to create an instance using the builder pattern

     CustomerShippingAddressAddedMessagePayload customerShippingAddressAddedMessagePayload = CustomerShippingAddressAddedMessagePayload.builder()
             .address(addressBuilder -> addressBuilder)
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CUSTOMER_SHIPPING_ADDRESS_ADDED	discriminator value for CustomerShippingAddressAddedMessagePayload

Method Summary

Modifier and Type	Method	Description
static CustomerShippingAddressAddedMessagePayloadBuilder	builder()	builder factory method for CustomerShippingAddressAddedMessagePayload
static CustomerShippingAddressAddedMessagePayloadBuilder	builder(CustomerShippingAddressAddedMessagePayload template)	create builder for CustomerShippingAddressAddedMessagePayload instance
CustomerShippingAddressAddedMessagePayload	copyDeep()
static CustomerShippingAddressAddedMessagePayload	deepCopy(CustomerShippingAddressAddedMessagePayload template)	factory method to create a deep copy of CustomerShippingAddressAddedMessagePayload
@NotNull @Valid Address	getAddress()	The address that was added to the Customer shippingAddressIds.
static CustomerShippingAddressAddedMessagePayload	of()	factory method
static CustomerShippingAddressAddedMessagePayload	of(CustomerShippingAddressAddedMessagePayload template)	factory method to create a shallow copy CustomerShippingAddressAddedMessagePayload
void	setAddress(Address address)	The address that was added to the Customer shippingAddressIds.
static com.fasterxml.jackson.core.type.TypeReference<CustomerShippingAddressAddedMessagePayload>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withCustomerShippingAddressAddedMessagePayload(Function<CustomerShippingAddressAddedMessagePayload,T> helper)	accessor map function

Methods inherited from interface com.commercetools.api.models.message.MessagePayload

getType, withMessagePayload

Methods inherited from interface com.commercetools.api.models.message.MessagePayloadMixin

as

Field Details

CUSTOMER_SHIPPING_ADDRESS_ADDED

static final String CUSTOMER_SHIPPING_ADDRESS_ADDED

discriminator value for CustomerShippingAddressAddedMessagePayload

See Also:

• Constant Field Values

Method Details

getAddress

@NotNull
@Valid
@NotNull @Valid Address getAddress()

The address that was added to the Customer shippingAddressIds.

Returns:

address

setAddress

void setAddress(Address address)

The address that was added to the Customer shippingAddressIds.

Parameters:

address - value to be set

of

static CustomerShippingAddressAddedMessagePayload of()

factory method

Returns:

instance of CustomerShippingAddressAddedMessagePayload

of

static CustomerShippingAddressAddedMessagePayload of(CustomerShippingAddressAddedMessagePayload template)

factory method to create a shallow copy CustomerShippingAddressAddedMessagePayload

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

CustomerShippingAddressAddedMessagePayload copyDeep()

Specified by:

copyDeep in interface MessagePayload

deepCopy

@Nullable
static CustomerShippingAddressAddedMessagePayload deepCopy(@Nullable
 CustomerShippingAddressAddedMessagePayload template)

factory method to create a deep copy of CustomerShippingAddressAddedMessagePayload

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static CustomerShippingAddressAddedMessagePayloadBuilder builder()

builder factory method for CustomerShippingAddressAddedMessagePayload

Returns:

builder

builder

static CustomerShippingAddressAddedMessagePayloadBuilder builder(CustomerShippingAddressAddedMessagePayload template)

create builder for CustomerShippingAddressAddedMessagePayload instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withCustomerShippingAddressAddedMessagePayload

default <T> T withCustomerShippingAddressAddedMessagePayload(Function<CustomerShippingAddressAddedMessagePayload,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<CustomerShippingAddressAddedMessagePayload> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference