Interface StagedOrderSetDeliveryCustomFieldAction
- All Superinterfaces:
ResourceUpdateAction<StagedOrderUpdateAction>,StagedOrderUpdateAction
Example to create an instance using the builder pattern
StagedOrderSetDeliveryCustomFieldAction stagedOrderSetDeliveryCustomFieldAction = StagedOrderSetDeliveryCustomFieldAction.builder()
.name("{name}")
.build()
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final Stringdiscriminator value for StagedOrderSetDeliveryCustomFieldAction -
Method Summary
Modifier and TypeMethodDescriptionbuilder()builder factory method for StagedOrderSetDeliveryCustomFieldActioncreate builder for StagedOrderSetDeliveryCustomFieldAction instancecopyDeep()factory method to create a deep copy of StagedOrderSetDeliveryCustomFieldActionidof an existing Delivery.keyof an existing Delivery.@NotNull StringgetName()Name of the Custom Field.getValue()Ifvalueis absent ornull, this field will be removed if it exists.of()factory methodof(StagedOrderSetDeliveryCustomFieldAction template) factory method to create a shallow copy StagedOrderSetDeliveryCustomFieldActionvoidsetDeliveryId(String deliveryId) idof an existing Delivery.voidsetDeliveryKey(String deliveryKey) keyof an existing Delivery.voidName of the Custom Field.voidIfvalueis absent ornull, this field will be removed if it exists.static com.fasterxml.jackson.core.type.TypeReference<StagedOrderSetDeliveryCustomFieldAction>gives a TypeReference for usage with Jackson DataBinddefault <T> TwithStagedOrderSetDeliveryCustomFieldAction(Function<StagedOrderSetDeliveryCustomFieldAction, T> helper) accessor map functionMethods inherited from interface com.commercetools.api.models.ResourceUpdateAction
getMethods inherited from interface com.commercetools.api.models.order.StagedOrderUpdateAction
getAction, withStagedOrderUpdateAction
-
Field Details
-
SET_DELIVERY_CUSTOM_FIELD
discriminator value for StagedOrderSetDeliveryCustomFieldAction- See Also:
-
-
Method Details
-
getDeliveryId
String getDeliveryId()idof an existing Delivery.Either
deliveryIdordeliveryKeymust be provided.- Returns:
- deliveryId
-
getDeliveryKey
String getDeliveryKey()keyof an existing Delivery.Either
deliveryIdordeliveryKeymust be provided.- Returns:
- deliveryKey
-
getName
Name of the Custom Field.
- Returns:
- name
-
getValue
Object getValue()If
valueis absent ornull, this field will be removed if it exists. Removing a field that does not exist returns an InvalidOperation error. Ifvalueis provided, it is set for the field defined byname.- Returns:
- value
-
setDeliveryId
idof an existing Delivery.Either
deliveryIdordeliveryKeymust be provided.- Parameters:
deliveryId- value to be set
-
setDeliveryKey
keyof an existing Delivery.Either
deliveryIdordeliveryKeymust be provided.- Parameters:
deliveryKey- value to be set
-
setName
Name of the Custom Field.
- Parameters:
name- value to be set
-
setValue
If
valueis absent ornull, this field will be removed if it exists. Removing a field that does not exist returns an InvalidOperation error. Ifvalueis provided, it is set for the field defined byname.- Parameters:
value- value to be set
-
of
factory method- Returns:
- instance of StagedOrderSetDeliveryCustomFieldAction
-
of
factory method to create a shallow copy StagedOrderSetDeliveryCustomFieldAction- Parameters:
template- instance to be copied- Returns:
- copy instance
-
copyDeep
StagedOrderSetDeliveryCustomFieldAction copyDeep()- Specified by:
copyDeepin interfaceStagedOrderUpdateAction
-
deepCopy
@Nullable static StagedOrderSetDeliveryCustomFieldAction deepCopy(@Nullable StagedOrderSetDeliveryCustomFieldAction template) factory method to create a deep copy of StagedOrderSetDeliveryCustomFieldAction- Parameters:
template- instance to be copied- Returns:
- copy instance
-
builder
builder factory method for StagedOrderSetDeliveryCustomFieldAction- Returns:
- builder
-
builder
static StagedOrderSetDeliveryCustomFieldActionBuilder builder(StagedOrderSetDeliveryCustomFieldAction template) create builder for StagedOrderSetDeliveryCustomFieldAction instance- Parameters:
template- instance with prefilled values for the builder- Returns:
- builder
-
withStagedOrderSetDeliveryCustomFieldAction
default <T> T withStagedOrderSetDeliveryCustomFieldAction(Function<StagedOrderSetDeliveryCustomFieldAction, T> helper) accessor map function- Type Parameters:
T- mapped type- Parameters:
helper- function to map the object- Returns:
- mapped value
-
ofUnset
-
typeReference
static com.fasterxml.jackson.core.type.TypeReference<StagedOrderSetDeliveryCustomFieldAction> typeReference()gives a TypeReference for usage with Jackson DataBind- Returns:
- TypeReference
-