Package com.commercetools.api.models.error

Interface ExtensionUpdateActionsFailedError

All Superinterfaces:
ErrorObject
public interface ExtensionUpdateActionsFailedError extends ErrorObject

Returned when update actions could not be applied to the resource (for example, because a referenced resource does not exist). This would result in a 400 Bad Request response if the same update action was sent from a regular client.

Example to create an instance using the builder pattern 

     ExtensionUpdateActionsFailedError extensionUpdateActionsFailedError = ExtensionUpdateActionsFailedError.builder()
             .message("{message}")
             .plusExtensionErrors(extensionErrorsBuilder -> extensionErrorsBuilder)
             .build()

  • Field Details

    • EXTENSION_UPDATE_ACTIONS_FAILED

      static final String EXTENSION_UPDATE_ACTIONS_FAILED
      discriminator value for ExtensionUpdateActionsFailedError
      See Also:

  • Method Details

    • getCode

      @NotNull @NotNull String getCode()
      Description copied from interface: ErrorObject

      Error identifier.

      Specified by:
      getCode in interface ErrorObject
      Returns:
      code

    • getMessage

      @NotNull @NotNull String getMessage()

      "The extension returned update actions that could not be executed."

      Specified by:
      getMessage in interface ErrorObject
      Returns:
      message

    • getLocalizedMessage

      @Valid @Valid LocalizedString getLocalizedMessage()

      User-defined localized description of the error.

      Returns:
      localizedMessage

    • getExtensionExtraInfo

      @Valid @Valid Object getExtensionExtraInfo()

      Any information that should be returned to the API caller.

      Returns:
      extensionExtraInfo

    • getExtensionErrors

      @NotNull @Valid @NotNull @Valid List<ExtensionError> getExtensionErrors()

      Additional errors related to the API Extension.

      Returns:
      extensionErrors

    • setMessage

      void setMessage(String message)

      "The extension returned update actions that could not be executed."

      Specified by:
      setMessage in interface ErrorObject
      Parameters:
      message - value to be set

    • setLocalizedMessage

      void setLocalizedMessage(LocalizedString localizedMessage)

      User-defined localized description of the error.

      Parameters:
      localizedMessage - value to be set

    • setExtensionExtraInfo

      void setExtensionExtraInfo(Object extensionExtraInfo)

      Any information that should be returned to the API caller.

      Parameters:
      extensionExtraInfo - value to be set

    • setExtensionErrors

      void setExtensionErrors(ExtensionError... extensionErrors)

      Additional errors related to the API Extension.

      Parameters:
      extensionErrors - values to be set

    • setExtensionErrors

      void setExtensionErrors(List<ExtensionError> extensionErrors)

      Additional errors related to the API Extension.

      Parameters:
      extensionErrors - values to be set

    • of

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

    • of

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

    • deepCopy

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

    • builder

      static ExtensionUpdateActionsFailedErrorBuilder builder()
      builder factory method for ExtensionUpdateActionsFailedError
      Returns:
      builder

    • builder

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

    • withExtensionUpdateActionsFailedError

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