Package com.commercetools.api.models.channel

Interface ChannelSetAddressCustomFieldAction

All Superinterfaces:
ChannelUpdateAction, ResourceUpdateAction<ChannelUpdateAction>
All Known Implementing Classes:
ChannelSetAddressCustomFieldActionImpl
public interface ChannelSetAddressCustomFieldAction extends ChannelUpdateAction
ChannelSetAddressCustomFieldAction
Example to create an instance using the builder pattern 

     ChannelSetAddressCustomFieldAction channelSetAddressCustomFieldAction = ChannelSetAddressCustomFieldAction.builder()
             .name("{name}")
             .build()

  • Field Details

    • SET_ADDRESS_CUSTOM_FIELD

      static final String SET_ADDRESS_CUSTOM_FIELD
      discriminator value for ChannelSetAddressCustomFieldAction
      See Also:

  • Method Details

    • getName

      @NotNull @NotNull String getName()

      Name of the Custom Field.

      Returns:
      name

    • getValue

      Object getValue()

      Specifies the format of the value of the Custom Field defined by name. 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.

      Returns:
      value

    • setName

      void setName(String name)

      Name of the Custom Field.

      Parameters:
      name - value to be set

    • setValue

      void setValue(Object value)

      Specifies the format of the value of the Custom Field defined by name. 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.

      Parameters:
      value - value to be set

    • of

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

    • of

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

    • deepCopy

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

    • builder

      static ChannelSetAddressCustomFieldActionBuilder builder()
      builder factory method for ChannelSetAddressCustomFieldAction
      Returns:
      builder

    • builder

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

    • withChannelSetAddressCustomFieldAction

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

    • ofUnset

      static ChannelSetAddressCustomFieldAction ofUnset(String name)

    • typeReference

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