Package com.commercetools.api.models.shipping_method

Interface ShippingMethodSetCustomFieldAction

All Superinterfaces:
ResourceUpdateAction<ShippingMethodUpdateAction>, ShippingMethodUpdateAction
All Known Implementing Classes:
ShippingMethodSetCustomFieldActionImpl
public interface ShippingMethodSetCustomFieldAction extends ShippingMethodUpdateAction

This action sets, overwrites, or removes any existing Custom Field for an existing ShippingMethod.

Example to create an instance using the builder pattern 

     ShippingMethodSetCustomFieldAction shippingMethodSetCustomFieldAction = ShippingMethodSetCustomFieldAction.builder()
             .name("{name}")
             .build()

  • Field Details

    • SET_CUSTOM_FIELD

      static final String SET_CUSTOM_FIELD
      discriminator value for ShippingMethodSetCustomFieldAction
      See Also:

  • Method Details

    • getName

      @NotNull @NotNull String getName()

      Name of the Custom Field.

      Returns:
      name

    • getValue

      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

    • setName

      void setName(String name)

      Name of the Custom Field.

      Parameters:
      name - value to be set

    • setValue

      void setValue(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

    • of

      static ShippingMethodSetCustomFieldAction of()
      factory method
      Returns:
      instance of ShippingMethodSetCustomFieldAction

    • of

      static ShippingMethodSetCustomFieldAction of(ShippingMethodSetCustomFieldAction template)
      factory method to create a shallow copy ShippingMethodSetCustomFieldAction
      Parameters:
      template - instance to be copied
      Returns:
      copy instance

    • deepCopy

      @Nullable static ShippingMethodSetCustomFieldAction deepCopy(@Nullable ShippingMethodSetCustomFieldAction template)
      factory method to create a deep copy of ShippingMethodSetCustomFieldAction
      Parameters:
      template - instance to be copied
      Returns:
      copy instance

    • builder

      static ShippingMethodSetCustomFieldActionBuilder builder()
      builder factory method for ShippingMethodSetCustomFieldAction
      Returns:
      builder

    • builder

      static ShippingMethodSetCustomFieldActionBuilder builder(ShippingMethodSetCustomFieldAction template)
      create builder for ShippingMethodSetCustomFieldAction instance
      Parameters:
      template - instance with prefilled values for the builder
      Returns:
      builder

    • withShippingMethodSetCustomFieldAction

      default <T> T withShippingMethodSetCustomFieldAction(Function<ShippingMethodSetCustomFieldAction,T> helper)
      accessor map function
      Type Parameters:
      T - mapped type
      Parameters:
      helper - function to map the object
      Returns:
      mapped value

    • ofUnset

      static ShippingMethodSetCustomFieldAction ofUnset(String name)

    • typeReference

      static com.fasterxml.jackson.core.type.TypeReference<ShippingMethodSetCustomFieldAction> typeReference()
      gives a TypeReference for usage with Jackson DataBind
      Returns:
      TypeReference