Package com.commercetools.api.models.type

Interface TypeChangeLabelAction

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

     TypeChangeLabelAction typeChangeLabelAction = TypeChangeLabelAction.builder()
             .fieldName("{fieldName}")
             .label(labelBuilder -> labelBuilder)
             .build()

  • Field Details

  • Method Details

    • getFieldName

      @NotNull @NotNull String getFieldName()

      Name of the Field Definition to update.

      Returns:
      fieldName

    • getLabel

      @NotNull @Valid @NotNull @Valid LocalizedString getLabel()

      New value to set. Must not be empty.

      Returns:
      label

    • setFieldName

      void setFieldName(String fieldName)

      Name of the Field Definition to update.

      Parameters:
      fieldName - value to be set

    • setLabel

      void setLabel(LocalizedString label)

      New value to set. Must not be empty.

      Parameters:
      label - value to be set

    • of

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

    • of

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

    • deepCopy

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

    • builder

      static TypeChangeLabelActionBuilder builder()
      builder factory method for TypeChangeLabelAction
      Returns:
      builder

    • builder

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

    • withTypeChangeLabelAction

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