Package com.commercetools.api.models.error

Interface ErrorResponse

All Known Subinterfaces:
AuthErrorResponse, ProductSearchErrorResponse
public interface ErrorResponse

Base representation of an error response containing common fields to all errors.

Example to create an instance using the builder pattern 

     ErrorResponse errorResponse = ErrorResponse.builder()
             .statusCode(1)
             .message("{message}")
             .build()

  • Method Details

    • getStatusCode

      @NotNull @NotNull Integer getStatusCode()

      HTTP status code corresponding to the error.

      Returns:
      statusCode

    • getMessage

      @NotNull @NotNull String getMessage()

      First error message in the errors array.

      Returns:
      message

    • getErrors

      @Valid @Valid List<ErrorObject> getErrors()

      Errors returned for a request.

      A single error response can contain multiple errors if the errors are related to the same HTTP status code such as 400.

      Returns:
      errors

    • setStatusCode

      void setStatusCode(Integer statusCode)

      HTTP status code corresponding to the error.

      Parameters:
      statusCode - value to be set

    • setMessage

      void setMessage(String message)

      First error message in the errors array.

      Parameters:
      message - value to be set

    • setErrors

      void setErrors(ErrorObject... errors)

      Errors returned for a request.

      A single error response can contain multiple errors if the errors are related to the same HTTP status code such as 400.

      Parameters:
      errors - values to be set

    • setErrors

      void setErrors(List<ErrorObject> errors)

      Errors returned for a request.

      A single error response can contain multiple errors if the errors are related to the same HTTP status code such as 400.

      Parameters:
      errors - values to be set

    • of

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

    • of

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

    • deepCopy

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

    • builder

      static ErrorResponseBuilder builder()
      builder factory method for ErrorResponse
      Returns:
      builder

    • builder

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

    • withErrorResponse

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