Package com.commercetools.api.models.error

Interface ExtensionBadResponseError

All Superinterfaces:
ErrorObject
public interface ExtensionBadResponseError extends ErrorObject

Returned when the response from the API Extension could not be parsed successfully (such as a 500 HTTP status code, or an invalid JSON response).

Example to create an instance using the builder pattern 

     ExtensionBadResponseError extensionBadResponseError = ExtensionBadResponseError.builder()
             .message("{message}")
             .plusExtensionErrors(extensionErrorsBuilder -> extensionErrorsBuilder)
             .extensionId("{extensionId}")
             .build()

  • Field Details

    • EXTENSION_BAD_RESPONSE

      static final String EXTENSION_BAD_RESPONSE
      discriminator value for ExtensionBadResponseError
      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()

      Description of the invalid Extension response. For example, "The extension did not return the expected JSON.".

      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

    • getExtensionBody

      String getExtensionBody()

      The response body returned by the Extension.

      Returns:
      extensionBody

    • getExtensionStatusCode

      Integer getExtensionStatusCode()

      Http status code returned by the Extension.

      Returns:
      extensionStatusCode

    • getExtensionId

      @NotNull @NotNull String getExtensionId()

      Unique identifier of the Extension.

      Returns:
      extensionId

    • getExtensionKey

      String getExtensionKey()

      User-defined unique identifier of the Extension.

      Returns:
      extensionKey

    • setMessage

      void setMessage(String message)

      Description of the invalid Extension response. For example, "The extension did not return the expected JSON.".

      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

    • setExtensionBody

      void setExtensionBody(String extensionBody)

      The response body returned by the Extension.

      Parameters:
      extensionBody - value to be set

    • setExtensionStatusCode

      void setExtensionStatusCode(Integer extensionStatusCode)

      Http status code returned by the Extension.

      Parameters:
      extensionStatusCode - value to be set

    • setExtensionId

      void setExtensionId(String extensionId)

      Unique identifier of the Extension.

      Parameters:
      extensionId - value to be set

    • setExtensionKey

      void setExtensionKey(String extensionKey)

      User-defined unique identifier of the Extension.

      Parameters:
      extensionKey - value to be set

    • of

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

    • of

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

    • copyDeep

      ExtensionBadResponseError copyDeep()
      Specified by:
      copyDeep in interface ErrorObject

    • deepCopy

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

    • builder

      static ExtensionBadResponseErrorBuilder builder()
      builder factory method for ExtensionBadResponseError
      Returns:
      builder

    • builder

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

    • withExtensionBadResponseError

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