Interface StagedOrderSetDeliveryCustomFieldAction
- All Superinterfaces:
ResourceUpdateAction<StagedOrderUpdateAction>
,StagedOrderUpdateAction
- All Known Implementing Classes:
StagedOrderSetDeliveryCustomFieldActionImpl
StagedOrderSetDeliveryCustomFieldAction
Example to create an instance using the builder pattern
Example to create an instance using the builder pattern
StagedOrderSetDeliveryCustomFieldAction stagedOrderSetDeliveryCustomFieldAction = StagedOrderSetDeliveryCustomFieldAction.builder()
.name("{name}")
.build()
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
discriminator value for StagedOrderSetDeliveryCustomFieldAction -
Method Summary
Modifier and TypeMethodDescriptionbuilder()
builder factory method for StagedOrderSetDeliveryCustomFieldActioncreate builder for StagedOrderSetDeliveryCustomFieldAction instancefactory method to create a deep copy of StagedOrderSetDeliveryCustomFieldActionEitherdeliveryId
ordeliveryKey
is required for this update action.EitherdeliveryId
ordeliveryKey
is required for this update action.@NotNull String
getName()
Name of the Custom Field.getValue()
Ifvalue
is absent ornull
, this field will be removed if it exists.of()
factory methodof
(StagedOrderSetDeliveryCustomFieldAction template) factory method to create a shallow copy StagedOrderSetDeliveryCustomFieldActionvoid
setDeliveryId
(String deliveryId) EitherdeliveryId
ordeliveryKey
is required for this update action.void
setDeliveryKey
(String deliveryKey) EitherdeliveryId
ordeliveryKey
is required for this update action.void
Name of the Custom Field.void
Ifvalue
is 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> T
withStagedOrderSetDeliveryCustomFieldAction
(Function<StagedOrderSetDeliveryCustomFieldAction, T> helper) accessor map functionMethods inherited from interface com.commercetools.api.models.ResourceUpdateAction
get
Methods 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
Either
deliveryId
ordeliveryKey
is required for this update action.- Returns:
- deliveryId
-
getDeliveryKey
Either
deliveryId
ordeliveryKey
is required for this update action.- Returns:
- deliveryKey
-
getName
Name of the Custom Field.
- Returns:
- name
-
getValue
If
value
is absent ornull
, this field will be removed if it exists. Removing a field that does not exist returns an InvalidOperation error. Ifvalue
is provided, it is set for the field defined byname
.- Returns:
- value
-
setDeliveryId
Either
deliveryId
ordeliveryKey
is required for this update action.- Parameters:
deliveryId
- value to be set
-
setDeliveryKey
Either
deliveryId
ordeliveryKey
is required for this update action.- Parameters:
deliveryKey
- value to be set
-
setName
Name of the Custom Field.
- Parameters:
name
- value to be set
-
setValue
If
value
is absent ornull
, this field will be removed if it exists. Removing a field that does not exist returns an InvalidOperation error. Ifvalue
is 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
-
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
-