public class DocumentClientException extends Exception
Errors coming from the service during normal execution are converted to DocumentClientException before returning to the application with the following exception:
When a BE error is encountered during a QueryIterable<T> iteration, an IllegalStateException is thrown instead of DocumentClientException.
When a transport level error happens that request is not able to reach the service, an IllegalStateException is thrown instead of DocumentClientException.
Constructor and Description |
---|
DocumentClientException(int statusCode)
Creates a new instance of the DocumentClientException class.
|
DocumentClientException(int statusCode,
Error errorResource,
Map<String,String> responseHeaders)
Creates a new instance of the DocumentClientException class.
|
DocumentClientException(int statusCode,
Exception innerException)
Creates a new instance of the DocumentClientException class.
|
DocumentClientException(int statusCode,
String errorMessage)
Creates a new instance of the DocumentClientException class.
|
DocumentClientException(String resourceAddress,
int statusCode,
Error errorResource,
Map<String,String> responseHeaders)
Creates a new instance of the DocumentClientException class.
|
Modifier and Type | Method and Description |
---|---|
String |
getActivityId()
Gets the activity ID associated with the request.
|
Error |
getError()
Gets the error code associated with the exception.
|
Map<String,String> |
getResponseHeaders()
Gets the response headers as key-value pairs
|
long |
getRetryAfterInMilliseconds()
Gets the recommended time interval after which the client can retry
failed requests
|
int |
getStatusCode()
Gets the http status code.
|
Integer |
getSubStatusCode()
Gets the sub status code.
|
addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
public DocumentClientException(int statusCode)
statusCode
- the http status code of the response.public DocumentClientException(int statusCode, String errorMessage)
statusCode
- the http status code of the response.errorMessage
- the error message.public DocumentClientException(int statusCode, Exception innerException)
statusCode
- the http status code of the response.innerException
- the original exception.public DocumentClientException(int statusCode, Error errorResource, Map<String,String> responseHeaders)
statusCode
- the http status code of the response.errorResource
- the error resource object.responseHeaders
- the response headers.public DocumentClientException(String resourceAddress, int statusCode, Error errorResource, Map<String,String> responseHeaders)
resourceAddress
- the address of the resource the request is associated with.statusCode
- the http status code of the response.errorResource
- the error resource object.responseHeaders
- the response headers.public String getActivityId()
public int getStatusCode()
public Integer getSubStatusCode()
public Error getError()
public long getRetryAfterInMilliseconds()
Copyright © 2018. All rights reserved.