Class OrderSetShippingCustomFieldActionBuilder
- All Implemented Interfaces:
Builder<OrderSetShippingCustomFieldAction>
Example to create an instance using the builder pattern
OrderSetShippingCustomFieldAction orderSetShippingCustomFieldAction = OrderSetShippingCustomFieldAction.builder()
.name("{name}")
.build()
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbuild()
builds OrderSetShippingCustomFieldAction with checking for non-null required valuesbuilds OrderSetShippingCustomFieldAction without checking for non-null required valuesgetName()
Name of the Custom Field.TheshippingKey
of the Shipping to customize.getValue()
Ifvalue
is absent ornull
, this field will be removed if it exists.Name of the Custom Field.of()
factory method for an instance of OrderSetShippingCustomFieldActionBuilderof
(OrderSetShippingCustomFieldAction template) create builder for OrderSetShippingCustomFieldAction instanceshippingKey
(String shippingKey) TheshippingKey
of the Shipping to customize.Ifvalue
is absent ornull
, this field will be removed if it exists.
-
Constructor Details
-
OrderSetShippingCustomFieldActionBuilder
public OrderSetShippingCustomFieldActionBuilder()
-
-
Method Details
-
shippingKey
The
shippingKey
of the Shipping to customize. Used to specify which Shipping Method to customize on a Order withMultiple
ShippingMode. Leave this empty to customize the one and only ShippingMethod on aSingle
ShippingMode Order.- Parameters:
shippingKey
- value to be set- Returns:
- Builder
-
name
Name of the Custom Field.
- Parameters:
name
- value to be set- Returns:
- Builder
-
value
If
value
is absent ornull
, this field will be removed if it exists. Trying to remove a field that does not exist will fail with an InvalidOperation error. Ifvalue
is provided, it is set for the field defined byname
.- Parameters:
value
- value to be set- Returns:
- Builder
-
getShippingKey
The
shippingKey
of the Shipping to customize. Used to specify which Shipping Method to customize on a Order withMultiple
ShippingMode. Leave this empty to customize the one and only ShippingMethod on aSingle
ShippingMode Order.- Returns:
- shippingKey
-
getName
Name of the Custom Field.
- Returns:
- name
-
getValue
If
value
is absent ornull
, this field will be removed if it exists. Trying to remove a field that does not exist will fail with an InvalidOperation error. Ifvalue
is provided, it is set for the field defined byname
.- Returns:
- value
-
build
builds OrderSetShippingCustomFieldAction with checking for non-null required values- Specified by:
build
in interfaceBuilder<OrderSetShippingCustomFieldAction>
- Returns:
- OrderSetShippingCustomFieldAction
-
buildUnchecked
builds OrderSetShippingCustomFieldAction without checking for non-null required values- Returns:
- OrderSetShippingCustomFieldAction
-
of
factory method for an instance of OrderSetShippingCustomFieldActionBuilder- Returns:
- builder
-
of
public static OrderSetShippingCustomFieldActionBuilder of(OrderSetShippingCustomFieldAction template) create builder for OrderSetShippingCustomFieldAction instance- Parameters:
template
- instance with prefilled values for the builder- Returns:
- builder
-