Interface OrderSetParcelCustomFieldAction
- All Superinterfaces:
OrderUpdateAction
,ResourceUpdateAction<OrderUpdateAction>
- All Known Implementing Classes:
OrderSetParcelCustomFieldActionImpl
OrderSetParcelCustomFieldAction
Example to create an instance using the builder pattern
Example to create an instance using the builder pattern
OrderSetParcelCustomFieldAction orderSetParcelCustomFieldAction = OrderSetParcelCustomFieldAction.builder()
.name("{name}")
.build()
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
discriminator value for OrderSetParcelCustomFieldAction -
Method Summary
Modifier and TypeMethodDescriptionbuilder()
builder factory method for OrderSetParcelCustomFieldActionbuilder
(OrderSetParcelCustomFieldAction template) create builder for OrderSetParcelCustomFieldAction instancedeepCopy
(OrderSetParcelCustomFieldAction template) factory method to create a deep copy of OrderSetParcelCustomFieldAction@NotNull String
getName()
Name of the Custom Field.EitherparcelId
orparcelKey
is required for this update action.EitherparcelId
orparcelKey
is required for this update action.getValue()
Ifvalue
is absent ornull
, this field will be removed if it exists.of()
factory methodof
(OrderSetParcelCustomFieldAction template) factory method to create a shallow copy OrderSetParcelCustomFieldActionvoid
Name of the Custom Field.void
setParcelId
(String parcelId) EitherparcelId
orparcelKey
is required for this update action.void
setParcelKey
(String parcelKey) EitherparcelId
orparcelKey
is required for this update action.void
Ifvalue
is absent ornull
, this field will be removed if it exists.static com.fasterxml.jackson.core.type.TypeReference<OrderSetParcelCustomFieldAction>
gives a TypeReference for usage with Jackson DataBinddefault <T> T
accessor map functionMethods inherited from interface com.commercetools.api.models.order.OrderUpdateAction
getAction, withOrderUpdateAction
Methods inherited from interface com.commercetools.api.models.ResourceUpdateAction
get
-
Field Details
-
SET_PARCEL_CUSTOM_FIELD
discriminator value for OrderSetParcelCustomFieldAction- See Also:
-
-
Method Details
-
getParcelId
Either
parcelId
orparcelKey
is required for this update action.- Returns:
- parcelId
-
getParcelKey
Either
parcelId
orparcelKey
is required for this update action.- Returns:
- parcelKey
-
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
-
setParcelId
Either
parcelId
orparcelKey
is required for this update action.- Parameters:
parcelId
- value to be set
-
setParcelKey
Either
parcelId
orparcelKey
is required for this update action.- Parameters:
parcelKey
- 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 OrderSetParcelCustomFieldAction
-
of
factory method to create a shallow copy OrderSetParcelCustomFieldAction- Parameters:
template
- instance to be copied- Returns:
- copy instance
-
deepCopy
@Nullable static OrderSetParcelCustomFieldAction deepCopy(@Nullable OrderSetParcelCustomFieldAction template) factory method to create a deep copy of OrderSetParcelCustomFieldAction- Parameters:
template
- instance to be copied- Returns:
- copy instance
-
builder
builder factory method for OrderSetParcelCustomFieldAction- Returns:
- builder
-
builder
create builder for OrderSetParcelCustomFieldAction instance- Parameters:
template
- instance with prefilled values for the builder- Returns:
- builder
-
withOrderSetParcelCustomFieldAction
default <T> T withOrderSetParcelCustomFieldAction(Function<OrderSetParcelCustomFieldAction, 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<OrderSetParcelCustomFieldAction> typeReference()gives a TypeReference for usage with Jackson DataBind- Returns:
- TypeReference
-