Package com.commercetools.api.models.payment

Interface PaymentSetTransactionCustomFieldAction

All Superinterfaces:
PaymentUpdateAction, ResourceUpdateAction<PaymentUpdateAction>
public interface PaymentSetTransactionCustomFieldAction extends PaymentUpdateAction
PaymentSetTransactionCustomFieldAction
Example to create an instance using the builder pattern 

     PaymentSetTransactionCustomFieldAction paymentSetTransactionCustomFieldAction = PaymentSetTransactionCustomFieldAction.builder()
             .transactionId("{transactionId}")
             .name("{name}")
             .build()

  • Field Details

    • SET_TRANSACTION_CUSTOM_FIELD

      static final String SET_TRANSACTION_CUSTOM_FIELD
      discriminator value for PaymentSetTransactionCustomFieldAction
      See Also:

  • Method Details

    • getTransactionId

      @NotNull @NotNull String getTransactionId()

      Unique identifier of the Transaction.

      Returns:
      transactionId

    • 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

    • setTransactionId

      void setTransactionId(String transactionId)

      Unique identifier of the Transaction.

      Parameters:
      transactionId - value to be set

    • 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 PaymentSetTransactionCustomFieldAction of()
      factory method
      Returns:
      instance of PaymentSetTransactionCustomFieldAction

    • of

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

    • deepCopy

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

    • builder

      static PaymentSetTransactionCustomFieldActionBuilder builder()
      builder factory method for PaymentSetTransactionCustomFieldAction
      Returns:
      builder

    • builder

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

    • withPaymentSetTransactionCustomFieldAction

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

    • ofUnset

      static PaymentSetTransactionCustomFieldAction ofUnset(String name, String transactionId)

    • typeReference

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