Package com.commercetools.api.models.state

Interface StateSetDescriptionAction

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

     StateSetDescriptionAction stateSetDescriptionAction = StateSetDescriptionAction.builder()
             .description(descriptionBuilder -> descriptionBuilder)
             .build()

  • Field Details

    • SET_DESCRIPTION

      static final String SET_DESCRIPTION
      discriminator value for StateSetDescriptionAction
      See Also:

  • Method Details

    • getDescription

      @NotNull @Valid @NotNull @Valid LocalizedString getDescription()

      Value to set. If the new value is the same as the current value, an InvalidOperation error is returned.

      Set to an empty object to remove any existing value.

      Returns:
      description

    • setDescription

      void setDescription(LocalizedString description)

      Value to set. If the new value is the same as the current value, an InvalidOperation error is returned.

      Set to an empty object to remove any existing value.

      Parameters:
      description - value to be set

    • of

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

    • of

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

    • copyDeep

      StateSetDescriptionAction copyDeep()
      Specified by:
      copyDeep in interface StateUpdateAction

    • deepCopy

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

    • builder

      static StateSetDescriptionActionBuilder builder()
      builder factory method for StateSetDescriptionAction
      Returns:
      builder

    • builder

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

    • withStateSetDescriptionAction

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

    • typeReference

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