public class CosmosClientException extends RuntimeException
Errors coming from the service during normal execution are converted to CosmosClientException 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 CosmosClientException.
When a transport level error happens that request is not able to reach the service, an IllegalStateException is thrown instead of CosmosClientException.
Modifier | Constructor and Description |
---|---|
protected |
CosmosClientException(int statusCode,
CosmosError cosmosErrorResource,
Map<String,String> responseHeaders)
Creates a new instance of the CosmosClientException class.
|
protected |
CosmosClientException(int statusCode,
Exception innerException)
Creates a new instance of the CosmosClientException class.
|
protected |
CosmosClientException(int statusCode,
String errorMessage)
Creates a new instance of the CosmosClientException class.
|
protected |
CosmosClientException(int statusCode,
String message,
Map<String,String> responseHeaders,
Throwable cause) |
protected |
CosmosClientException(String message,
Exception exception,
Map<String,String> responseHeaders,
int statusCode,
String resourceAddress)
Creates a new instance of the CosmosClientException class.
|
protected |
CosmosClientException(String resourceAddress,
int statusCode,
CosmosError cosmosErrorResource,
Map<String,String> responseHeaders)
Creates a new instance of the CosmosClientException class.
|
Modifier and Type | Method and Description |
---|---|
String |
getActivityId()
Gets the activity ID associated with the request.
|
CosmosError |
getError()
Gets the error code associated with the exception.
|
String |
getMessage() |
CosmosResponseDiagnostics |
getResponseDiagnostics()
Gets the Cosmos Response Diagnostic Statistics associated with this exception.
|
Map<String,String> |
getResponseHeaders()
Gets the response headers as key-value pairs
|
Duration |
getRetryAfterDuration()
Gets the recommended time duration after which the client can retry failed
requests
|
int |
getStatusCode()
Gets the http status code.
|
int |
getSubStatusCode()
Gets the sub status code.
|
String |
toString() |
addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace
protected CosmosClientException(int statusCode, String message, Map<String,String> responseHeaders, Throwable cause)
protected CosmosClientException(int statusCode, String errorMessage)
statusCode
- the http status code of the response.errorMessage
- the error message.protected CosmosClientException(int statusCode, Exception innerException)
statusCode
- the http status code of the response.innerException
- the original exception.protected CosmosClientException(int statusCode, CosmosError cosmosErrorResource, Map<String,String> responseHeaders)
statusCode
- the http status code of the response.cosmosErrorResource
- the error resource object.responseHeaders
- the response headers.protected CosmosClientException(String resourceAddress, int statusCode, CosmosError cosmosErrorResource, Map<String,String> responseHeaders)
resourceAddress
- the address of the resource the request is associated with.statusCode
- the http status code of the response.cosmosErrorResource
- the error resource object.responseHeaders
- the response headers.protected CosmosClientException(String message, Exception exception, Map<String,String> responseHeaders, int statusCode, String resourceAddress)
message
- the string message.statusCode
- the http status code of the response.exception
- the exception object.responseHeaders
- the response headers.resourceAddress
- the address of the resource the request is associated with.public String getMessage()
getMessage
in class Throwable
public String getActivityId()
public int getStatusCode()
public int getSubStatusCode()
public CosmosError getError()
public Duration getRetryAfterDuration()
public Map<String,String> getResponseHeaders()
public CosmosResponseDiagnostics getResponseDiagnostics()
Copyright © 2020 Microsoft Corporation. All rights reserved.