Interface CustomerAddressCustomFieldAddedMessage
- All Superinterfaces:
BaseResource,DomainResource<Message>,Identifiable<Message>,Message,Versioned<Message>
Generated after adding a Custom Field to an Address of a Customer using the Set CustomField in Address update action. If a Custom Field already exists with the same name, a CustomerAddressCustomFieldChanged Message is generated instead.
Example to create an instance using the builder pattern
CustomerAddressCustomFieldAddedMessage customerAddressCustomFieldAddedMessage = CustomerAddressCustomFieldAddedMessage.builder()
.id("{id}")
.version(0.3)
.createdAt(ZonedDateTime.parse("2022-01-01T12:00:00.301Z"))
.lastModifiedAt(ZonedDateTime.parse("2022-01-01T12:00:00.301Z"))
.sequenceNumber(0.3)
.resource(resourceBuilder -> resourceBuilder)
.resourceVersion(0.3)
.name("{name}")
.build()
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final Stringdiscriminator value for CustomerAddressCustomFieldAddedMessage -
Method Summary
Modifier and TypeMethodDescriptionbuilder()builder factory method for CustomerAddressCustomFieldAddedMessagecreate builder for CustomerAddressCustomFieldAddedMessage instancecopyDeep()factory method to create a deep copy of CustomerAddressCustomFieldAddedMessageidof the Address to which the Custom Field was added.@NotNull StringgetName()Name of the Custom Field that was added.@NotNull ObjectgetValue()The added CustomFieldValue based on the FieldType.of()factory methodof(CustomerAddressCustomFieldAddedMessage template) factory method to create a shallow copy CustomerAddressCustomFieldAddedMessagevoidsetAddressId(String addressId) idof the Address to which the Custom Field was added.voidName of the Custom Field that was added.voidThe added CustomFieldValue based on the FieldType.static com.fasterxml.jackson.core.type.TypeReference<CustomerAddressCustomFieldAddedMessage>gives a TypeReference for usage with Jackson DataBinddefault <T> TwithCustomerAddressCustomFieldAddedMessage(Function<CustomerAddressCustomFieldAddedMessage, T> helper) accessor map functionMethods inherited from interface com.commercetools.api.models.common.BaseResource
withBaseResourceMethods inherited from interface com.commercetools.api.models.DomainResource
getMethods inherited from interface com.commercetools.api.models.message.Message
getCreatedAt, getCreatedBy, getId, getLastModifiedAt, getLastModifiedBy, getResource, getResourceUserProvidedIdentifiers, getResourceVersion, getSequenceNumber, getType, getVersion, setCreatedAt, setCreatedBy, setId, setLastModifiedAt, setLastModifiedBy, setResource, setResourceUserProvidedIdentifiers, setResourceVersion, setSequenceNumber, setVersion, withMessage
-
Field Details
-
CUSTOMER_ADDRESS_CUSTOM_FIELD_ADDED
discriminator value for CustomerAddressCustomFieldAddedMessage- See Also:
-
-
Method Details
-
getName
Name of the Custom Field that was added.
- Returns:
- name
-
getValue
The added CustomFieldValue based on the FieldType.
- Returns:
- value
-
getAddressId
String getAddressId()idof the Address to which the Custom Field was added.- Returns:
- addressId
-
setName
Name of the Custom Field that was added.
- Parameters:
name- value to be set
-
setValue
The added CustomFieldValue based on the FieldType.
- Parameters:
value- value to be set
-
setAddressId
idof the Address to which the Custom Field was added.- Parameters:
addressId- value to be set
-
of
factory method- Returns:
- instance of CustomerAddressCustomFieldAddedMessage
-
of
factory method to create a shallow copy CustomerAddressCustomFieldAddedMessage- Parameters:
template- instance to be copied- Returns:
- copy instance
-
copyDeep
CustomerAddressCustomFieldAddedMessage copyDeep()- Specified by:
copyDeepin interfaceBaseResource- Specified by:
copyDeepin interfaceMessage
-
deepCopy
@Nullable static CustomerAddressCustomFieldAddedMessage deepCopy(@Nullable CustomerAddressCustomFieldAddedMessage template) factory method to create a deep copy of CustomerAddressCustomFieldAddedMessage- Parameters:
template- instance to be copied- Returns:
- copy instance
-
builder
builder factory method for CustomerAddressCustomFieldAddedMessage- Returns:
- builder
-
builder
static CustomerAddressCustomFieldAddedMessageBuilder builder(CustomerAddressCustomFieldAddedMessage template) create builder for CustomerAddressCustomFieldAddedMessage instance- Parameters:
template- instance with prefilled values for the builder- Returns:
- builder
-
withCustomerAddressCustomFieldAddedMessage
default <T> T withCustomerAddressCustomFieldAddedMessage(Function<CustomerAddressCustomFieldAddedMessage, 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<CustomerAddressCustomFieldAddedMessage> typeReference()gives a TypeReference for usage with Jackson DataBind- Returns:
- TypeReference
-