Package com.azure.cosmos
Class CosmosException
java.lang.Object
java.lang.Throwable
java.lang.Exception
java.lang.RuntimeException
com.azure.core.exception.AzureException
com.azure.cosmos.CosmosException
- All Implemented Interfaces:
Serializable
public class CosmosException
extends com.azure.core.exception.AzureException
This class defines a custom exception type for all operations on
CosmosClient in the Azure Cosmos DB database service. Applications are
expected to catch CosmosException and handle errors as appropriate when
calling methods on CosmosClient.
Errors coming from the service during normal execution are converted to CosmosException 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 CosmosException.
When a transport level error happens that request is not able to reach the service, an IllegalStateException is thrown instead of CosmosException.
- See Also:
-
Constructor Summary
ModifierConstructorDescriptionprotected
CosmosException
(int statusCode, com.azure.cosmos.implementation.CosmosError cosmosErrorResource, Map<String, String> responseHeaders) Creates a new instance of the CosmosException class.protected
CosmosException
(int statusCode, Exception innerException) Creates a new instance of the CosmosException class.protected
CosmosException
(int statusCode, String errorMessage) Creates a new instance of the CosmosException class.protected
CosmosException
(int statusCode, String message, Map<String, String> responseHeaders, Throwable cause) Creates a new instance of the CosmosException class.protected
CosmosException
(String resourceAddress, int statusCode, com.azure.cosmos.implementation.CosmosError cosmosErrorResource, Map<String, String> responseHeaders) Creates a new instance of the CosmosException class.protected
CosmosException
(String resourceAddress, int statusCode, com.azure.cosmos.implementation.CosmosError cosmosErrorResource, Map<String, String> responseHeaders, Throwable cause) Creates a new instance of the CosmosException class.protected
CosmosException
(String message, Exception exception, Map<String, String> responseHeaders, int statusCode, String resourceAddress) Creates a new instance of the CosmosException class. -
Method Summary
Modifier and TypeMethodDescriptionGets the activity ID associated with the request.Gets the Cosmos Diagnostic Statistics associated with this exception.double
Gets the request charge as request units (RU) consumed by the operation.Gets the response headers as key-value pairsGets the recommended time duration after which the client can retry failed requestsReturns the error message without any diagnostics - using this method is only useful when also logging thegetDiagnostics()
separately.int
Gets the http status code.int
Gets the sub status code.toString()
Methods inherited from class java.lang.Throwable
addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace
-
Constructor Details
-
CosmosException
protected CosmosException(int statusCode, String message, Map<String, String> responseHeaders, Throwable cause) Creates a new instance of the CosmosException class.- Parameters:
statusCode
- the http status code of the response.message
- the string message.responseHeaders
- the response headers.cause
- the inner exception
-
CosmosException
Creates a new instance of the CosmosException class.- Parameters:
statusCode
- the http status code of the response.errorMessage
- the error message.
-
CosmosException
Creates a new instance of the CosmosException class.- Parameters:
statusCode
- the http status code of the response.innerException
- the original exception.
-
CosmosException
protected CosmosException(int statusCode, com.azure.cosmos.implementation.CosmosError cosmosErrorResource, Map<String, String> responseHeaders) Creates a new instance of the CosmosException class.- Parameters:
statusCode
- the http status code of the response.cosmosErrorResource
- the error resource object.responseHeaders
- the response headers.
-
CosmosException
protected CosmosException(String resourceAddress, int statusCode, com.azure.cosmos.implementation.CosmosError cosmosErrorResource, Map<String, String> responseHeaders) Creates a new instance of the CosmosException class.- Parameters:
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.
-
CosmosException
protected CosmosException(String resourceAddress, int statusCode, com.azure.cosmos.implementation.CosmosError cosmosErrorResource, Map<String, String> responseHeaders, Throwable cause) Creates a new instance of the CosmosException class.- Parameters:
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.cause
- the inner exception
-
CosmosException
protected CosmosException(String message, Exception exception, Map<String, String> responseHeaders, int statusCode, String resourceAddress) Creates a new instance of the CosmosException class.- Parameters:
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.
-
-
Method Details
-
getMessage
- Overrides:
getMessage
in classThrowable
-
getShortMessage
Returns the error message without any diagnostics - using this method is only useful when also logging thegetDiagnostics()
separately. Without diagnostics it will often be impossible to determine the root cause of an error.- Returns:
- the error message without any diagnostics
-
getActivityId
Gets the activity ID associated with the request.- Returns:
- the activity ID.
-
getStatusCode
public int getStatusCode()Gets the http status code.- Returns:
- the status code.
-
getSubStatusCode
public int getSubStatusCode()Gets the sub status code.- Returns:
- the status code.
-
getRetryAfterDuration
Gets the recommended time duration after which the client can retry failed requests- Returns:
- the recommended time duration after which the client can retry failed requests.
-
getResponseHeaders
Gets the response headers as key-value pairs- Returns:
- the response headers
-
getDiagnostics
Gets the Cosmos Diagnostic Statistics associated with this exception.- Returns:
- Cosmos Diagnostic Statistics associated with this exception.
-
getRequestCharge
public double getRequestCharge()Gets the request charge as request units (RU) consumed by the operation.For more information about the RU and factors that can impact the effective charges please visit Request Units in Azure Cosmos DB
- Returns:
- the request charge.
-
toString
-