algoliasearch.exception.AlgoliaRuntimeException.scala Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of algoliasearch-scala_3 Show documentation

Scala client for Algolia Search API

There is a newer version: 2.9.2

Show newest version

package algoliasearch.exception

/** Algolia runtime exception.
  *
  * @param message
  *   the detail message
  * @param cause
  *   the cause of the exception
  */
sealed abstract class AlgoliaRuntimeException(
    message: String = null,
    cause: Throwable = null
) extends RuntimeException(message, cause)

/** Exception thrown when an error occurs during API requests.
  *
  * @param message
  *   the detail message
  * @param cause
  *   the cause of the exception
  */
case class AlgoliaClientException(
    message: String = null,
    cause: Throwable = null
) extends AlgoliaRuntimeException(message, cause)

/** Exception thrown in case of API failure.
  *
  * @param message
  *   the detail message
  * @param cause
  *   the cause of the exception
  * @param httpErrorCode
  *   HTTP error code
  */
case class AlgoliaApiException(
    message: String = null,
    cause: Throwable = null,
    httpErrorCode: Int = -1
) extends AlgoliaRuntimeException(message, cause)

/** Exception thrown when an error occurs during API requests.
  *
  * @param message
  *   the detail message
  * @param cause
  *   the cause of the exception
  */
case class AlgoliaRequestException(
    message: String = null,
    cause: Throwable = null,
    httpErrorCode: Int = -1
) extends AlgoliaRuntimeException(message, cause)

/** Exception thrown when all hosts are unreachable. When several errors occurred, use the last one as the cause for the
  * returned exception.
  *
  * @param exceptions
  *   list of thrown exceptions
  */
case class AlgoliaRetryException(
    exceptions: List[Throwable]
) extends AlgoliaRuntimeException(
      "Error(s) while processing the retry strategy",
      exceptions.lastOption.orNull
    )

/** Exception thrown when an error occurs during the wait strategy. For example: maximum number of retry exceeded.
  *
  * @param message
  *   the detail message
  */
case class AlgoliaWaitException(
    message: String = null
) extends AlgoliaRuntimeException(message)