Interface TypeSetDescriptionAction

All Superinterfaces:
ResourceUpdateAction<TypeUpdateAction>, TypeUpdateAction

public interface TypeSetDescriptionAction extends TypeUpdateAction
TypeSetDescriptionAction
Example to create an instance using the builder pattern

     TypeSetDescriptionAction typeSetDescriptionAction = TypeSetDescriptionAction.builder()
             .build()
 
  • Field Details

    • SET_DESCRIPTION

      static final String SET_DESCRIPTION
      discriminator value for TypeSetDescriptionAction
      See Also:
  • Method Details

    • getDescription

      @Valid @Valid LocalizedString getDescription()

      Value to set. If empty, any existing value will be removed.

      Returns:
      description
    • setDescription

      void setDescription(LocalizedString description)

      Value to set. If empty, any existing value will be removed.

      Parameters:
      description - value to be set
    • of

      factory method
      Returns:
      instance of TypeSetDescriptionAction
    • of

      factory method to create a shallow copy TypeSetDescriptionAction
      Parameters:
      template - instance to be copied
      Returns:
      copy instance
    • deepCopy

      factory method to create a deep copy of TypeSetDescriptionAction
      Parameters:
      template - instance to be copied
      Returns:
      copy instance
    • builder

      builder factory method for TypeSetDescriptionAction
      Returns:
      builder
    • builder

      create builder for TypeSetDescriptionAction instance
      Parameters:
      template - instance with prefilled values for the builder
      Returns:
      builder
    • withTypeSetDescriptionAction

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