Package com.commercetools.api.models.payment_method

Interface PaymentMethodSetCustomFieldAction

All Superinterfaces:
PaymentMethodUpdateAction
public interface PaymentMethodSetCustomFieldAction extends PaymentMethodUpdateAction

Adding a Custom Field to a PaymentMethod generates the PaymentMethodCustomFieldAdded Message, removing one generates the PaymentMethodCustomFieldRemoved Message, and updating an existing one generates the PaymentMethodCustomFieldChanged Message.

Example to create an instance using the builder pattern 

     PaymentMethodSetCustomFieldAction paymentMethodSetCustomFieldAction = PaymentMethodSetCustomFieldAction.builder()
             .name("{name}")
             .build()

  • Field Details

    • SET_CUSTOM_FIELD

      static final String SET_CUSTOM_FIELD
      discriminator value for PaymentMethodSetCustomFieldAction
      See Also:

  • Method Details

    • getName

      @NotNull @NotNull String getName()

      Name of the Custom Field to add, update, or remove.

      Returns:
      name

    • getValue

      Object getValue()

      If value is absent or null, this field will be removed if it exists. Trying to remove a field that does not exist will fail with 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 to add, update, or remove.

      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. Trying to remove a field that does not exist will fail with an InvalidOperation error. If value is provided, it is set for the field defined by name.

      Parameters:
      value - value to be set

    • of

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

    • of

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

    • copyDeep

      PaymentMethodSetCustomFieldAction copyDeep()
      Specified by:
      copyDeep in interface PaymentMethodUpdateAction

    • deepCopy

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

    • builder

      static PaymentMethodSetCustomFieldActionBuilder builder()
      builder factory method for PaymentMethodSetCustomFieldAction
      Returns:
      builder

    • builder

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

    • withPaymentMethodSetCustomFieldAction

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

    • typeReference

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