Class EquinixRateLimitException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

com.eqixiac.equinix.core.exception.BaseException

com.eqixiac.equinix.core.exception.EquinixServiceException

com.eqixiac.equinix.core.exception.EquinixRateLimitException

All Implemented Interfaces:

Serializable

public class EquinixRateLimitException
extends EquinixServiceException

Thrown when the Equinix API returns HTTP 429 Too Many Requests. This indicates the client has exceeded the API rate limit. Implement exponential backoff and retry logic when catching this exception.

Author:

ianjones

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
EquinixRateLimitException(String errorMessage)
EquinixRateLimitException(String errorMessage, Exception cause)
EquinixRateLimitException(String errorMessage, Integer statusCode, String path, Map<String,String> httpHeaders, List<ExceptionDetail> exceptionDetails)
EquinixRateLimitException(String errorMessage, Integer statusCode, String path, Map<String,String> httpHeaders, List<ExceptionDetail> exceptionDetails, String correlationId)	Full constructor carrying the SDK-generated request correlation id; used by ResponseErrorMapper.
EquinixRateLimitException(String errorMessage, Integer statusCode, String path, Map<String,String> httpHeaders, List<ExceptionDetail> exceptionDetails, String correlationId, String responseBodySnippet)	Full constructor used by ResponseErrorMapper, additionally carrying a truncated snippet of an error body that could not be parsed into details.

Method Summary

Methods inherited from class EquinixServiceException

getMessage

Modifier and Type	Method	Description
String	getMessage()	The summary (which for a mapped HTTP error already ends with the first detail's <code>: <message> (field: <property>) line), followed by the HTTP status, URI and correlation id, then one block per parsed ExceptionDetail: Error: <code>: <message> (field: <property>) plus any details, developer message, help and property annotations.

Methods inherited from class Throwable

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

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

EquinixRateLimitException

public EquinixRateLimitException(String errorMessage)

EquinixRateLimitException

public EquinixRateLimitException(String errorMessage,
 Exception cause)

EquinixRateLimitException

public EquinixRateLimitException(String errorMessage,
 Integer statusCode,
 String path,
 Map<String,String> httpHeaders,
 List<ExceptionDetail> exceptionDetails)

EquinixRateLimitException

public EquinixRateLimitException(String errorMessage,
 Integer statusCode,
 String path,
 Map<String,String> httpHeaders,
 List<ExceptionDetail> exceptionDetails,
 String correlationId)

Full constructor carrying the SDK-generated request correlation id; used by ResponseErrorMapper.

Parameters:

errorMessage - a human-readable summary message.

statusCode - the HTTP status code returned by the API.

path - the request URI that produced the error.

httpHeaders - relevant response headers; may be null.

exceptionDetails - structured error details from the response body; may be null.

correlationId - the SDK-generated X-Correlation-Id of the failed request; may be null.

EquinixRateLimitException

public EquinixRateLimitException(String errorMessage,
 Integer statusCode,
 String path,
 Map<String,String> httpHeaders,
 List<ExceptionDetail> exceptionDetails,
 String correlationId,
 String responseBodySnippet)

Full constructor used by ResponseErrorMapper, additionally carrying a truncated snippet of an error body that could not be parsed into details.

Parameters:

errorMessage - a human-readable summary message.

statusCode - the HTTP status code returned by the API.

path - the request URI that produced the error.

httpHeaders - relevant response headers; may be null.

exceptionDetails - structured error details from the response body; may be null.

correlationId - the SDK-generated X-Correlation-Id of the failed request; may be null.

responseBodySnippet - truncated raw body when no details could be parsed; may be null.