Package com.commercetools.api.models.channel

Interface ChannelSetCustomTypeAction

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

     ChannelSetCustomTypeAction channelSetCustomTypeAction = ChannelSetCustomTypeAction.builder()
             .build()

  • Field Details

    • SET_CUSTOM_TYPE

      static final String SET_CUSTOM_TYPE
      discriminator value for ChannelSetCustomTypeAction
      See Also:

  • Method Details

    • getType

      @Valid @Valid TypeResourceIdentifier getType()

      Defines the Type that extends the Channel with Custom Fields. If absent, any existing Type and Custom Fields are removed from the Channel.

      Returns:
      type

    • getFields

      @Valid @Valid FieldContainer getFields()

      Object containing the Custom Fields fields for the Channel.

      Required if at least one Custom Field is defined as required in the fieldDefinitions of the referenced Type.

      Returns:
      fields

    • setType

      void setType(TypeResourceIdentifier type)

      Defines the Type that extends the Channel with Custom Fields. If absent, any existing Type and Custom Fields are removed from the Channel.

      Parameters:
      type - value to be set

    • setFields

      void setFields(FieldContainer fields)

      Object containing the Custom Fields fields for the Channel.

      Required if at least one Custom Field is defined as required in the fieldDefinitions of the referenced Type.

      Parameters:
      fields - value to be set

    • of

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

    • of

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

    • copyDeep

      ChannelSetCustomTypeAction copyDeep()
      Specified by:
      copyDeep in interface ChannelUpdateAction

    • deepCopy

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

    • builder

      static ChannelSetCustomTypeActionBuilder builder()
      builder factory method for ChannelSetCustomTypeAction
      Returns:
      builder

    • builder

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

    • withChannelSetCustomTypeAction

      default <T> T withChannelSetCustomTypeAction(Function<ChannelSetCustomTypeAction,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<ChannelSetCustomTypeAction> typeReference()
      gives a TypeReference for usage with Jackson DataBind
      Returns:
      TypeReference