com.algolia.search.saas

Class AlgoliaException

Object

Throwable

Exception

com.algolia.search.saas.AlgoliaException

All Implemented Interfaces:

Serializable

public class AlgoliaException
extends Exception

Any error that was encountered during the processing of a request. Could be server-side, network failure, or client-side.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AlgoliaException(String message)
AlgoliaException(String message, int statusCode)
AlgoliaException(String message, Throwable throwable)

Method Summary

Modifier and Type	Method and Description
int	getStatusCode() Get the error's HTTP status code (if any).
boolean	isTransient() Test whether this error is transient.

Methods inherited from class Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

AlgoliaException

public AlgoliaException(String message)

AlgoliaException

public AlgoliaException(String message,
                        Throwable throwable)

AlgoliaException

public AlgoliaException(String message,
                        int statusCode)

Method Detail

getStatusCode

public int getStatusCode()

Get the error's HTTP status code (if any). Only valid when the exception is an application-level error. Values are documented in the REST API.

Returns:

The HTTP status code, or 0 if not available.

isTransient

public boolean isTransient()

Test whether this error is transient.

Returns:

true if transient, false if fatal.