Package com.commercetools.api.models.order

Class OrderSetDeliveryCustomFieldActionBuilder

java.lang.Object
com.commercetools.api.models.order.OrderSetDeliveryCustomFieldActionBuilder
All Implemented Interfaces:
Builder<OrderSetDeliveryCustomFieldAction>
public class OrderSetDeliveryCustomFieldActionBuilder extends Object implements Builder<OrderSetDeliveryCustomFieldAction>
OrderSetDeliveryCustomFieldActionBuilder
Example to create an instance using the builder pattern 

     OrderSetDeliveryCustomFieldAction orderSetDeliveryCustomFieldAction = OrderSetDeliveryCustomFieldAction.builder()
             .name("{name}")
             .build()

  • Constructor Details

    • OrderSetDeliveryCustomFieldActionBuilder

      public OrderSetDeliveryCustomFieldActionBuilder()

  • Method Details

    • deliveryId

      public OrderSetDeliveryCustomFieldActionBuilder deliveryId(@Nullable String deliveryId)

      id of an existing Delivery.

      Either deliveryId or deliveryKey must be provided.

      Parameters:
      deliveryId - value to be set
      Returns:
      Builder

    • deliveryKey

      public OrderSetDeliveryCustomFieldActionBuilder deliveryKey(@Nullable String deliveryKey)

      key of an existing Delivery.

      Either deliveryId or deliveryKey must be provided.

      Parameters:
      deliveryKey - value to be set
      Returns:
      Builder

    • name

      public OrderSetDeliveryCustomFieldActionBuilder name(String name)

      Name of the Custom Field.

      Parameters:
      name - value to be set
      Returns:
      Builder

    • value

      public OrderSetDeliveryCustomFieldActionBuilder value(@Nullable Object value)

      If value is absent or null, this field will be removed if it exists. Removing a field that does not exist returns an InvalidOperation error. If value is provided, it is set for the field defined by name.

      Parameters:
      value - value to be set
      Returns:
      Builder

    • getDeliveryId

      @Nullable public String getDeliveryId()

      id of an existing Delivery.

      Either deliveryId or deliveryKey must be provided.

      Returns:
      deliveryId

    • getDeliveryKey

      @Nullable public String getDeliveryKey()

      key of an existing Delivery.

      Either deliveryId or deliveryKey must be provided.

      Returns:
      deliveryKey

    • getName

      public String getName()

      Name of the Custom Field.

      Returns:
      name

    • getValue

      @Nullable public Object getValue()

      If value is absent or null, this field will be removed if it exists. Removing a field that does not exist returns an InvalidOperation error. If value is provided, it is set for the field defined by name.

      Returns:
      value

    • build

      public OrderSetDeliveryCustomFieldAction build()
      builds OrderSetDeliveryCustomFieldAction with checking for non-null required values
      Specified by:
      build in interface Builder<OrderSetDeliveryCustomFieldAction>
      Returns:
      OrderSetDeliveryCustomFieldAction

    • buildUnchecked

      public OrderSetDeliveryCustomFieldAction buildUnchecked()
      builds OrderSetDeliveryCustomFieldAction without checking for non-null required values
      Returns:
      OrderSetDeliveryCustomFieldAction

    • of

      public static OrderSetDeliveryCustomFieldActionBuilder of()
      factory method for an instance of OrderSetDeliveryCustomFieldActionBuilder
      Returns:
      builder

    • of

      public static OrderSetDeliveryCustomFieldActionBuilder of(OrderSetDeliveryCustomFieldAction template)
      create builder for OrderSetDeliveryCustomFieldAction instance
      Parameters:
      template - instance with prefilled values for the builder
      Returns:
      builder