com.azure.cosmos

Class CosmosClientException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

com.azure.cosmos.CosmosClientException

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

BadRequestException, ConflictException, ForbiddenException, GoneException, InternalServerErrorException, InvalidPartitionException, LockedException, MethodNotAllowedException, NotFoundException, PartitionIsMigratingException, PartitionKeyRangeGoneException, PartitionKeyRangeIsSplittingException, PreconditionFailedException, RequestEntityTooLargeException, RequestRateTooLargeException, RequestTimeoutException, RetryWithException, ServiceUnavailableException, UnauthorizedException

public class CosmosClientException
extends RuntimeException

This class defines a custom exception type for all operations on CosmosClient in the Azure Cosmos DB database service. Applications are expected to catch CosmosClientException and handle errors as appropriate when calling methods on CosmosClient.

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.

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
String	getActivityId() Gets the activity ID associated with the request.
CosmosResponseDiagnostics	getCosmosResponseDiagnostics() Gets the Cosmos Response Diagnostic Statistics associated with this exception.
CosmosError	getError() Gets the error code associated with the exception.
String	getMessage()
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.
int	getSubStatusCode() Gets the sub status code.
void	setResourceAddress(String resourceAddress)
String	toString()

Methods inherited from class java.lang.Throwable

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

Methods inherited from class java.lang.Object

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

Method Detail

getMessage

public String getMessage()

Overrides:

getMessage in class Throwable

getActivityId

public String 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.

getError

public CosmosError getError()

Gets the error code associated with the exception.

Returns:

the error.

getRetryAfterInMilliseconds

public long getRetryAfterInMilliseconds()

Gets the recommended time interval after which the client can retry failed requests

Returns:

the recommended time interval after which the client can retry failed requests.

getResponseHeaders

public Map<String,String> getResponseHeaders()

Gets the response headers as key-value pairs

Returns:

the response headers

getCosmosResponseDiagnostics

public CosmosResponseDiagnostics getCosmosResponseDiagnostics()

Gets the Cosmos Response Diagnostic Statistics associated with this exception.

Returns:

Cosmos Response Diagnostic Statistics associated with this exception.

toString

public String toString()

Overrides:

toString in class Throwable

setResourceAddress

public void setResourceAddress(String resourceAddress)