Share via

DocumentClientException Class

  • Reference
Package:
com.microsoft.azure.documentdb
  • java.lang.Object
    • Exception
      • com.microsoft.azure.documentdb.DocumentClientException

public class DocumentClientException

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

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 Summary

Constructor 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, Exception innerException, Map<String, String> responseHeaders)

Creates a new instance of the DocumentClientException class.

<xreftitle>Deprecated</xreftitle>

<xrefdescription>

  <p>this constructor is deprecated and is used internally only. </p>

</xrefdescription>

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.

Method Summary

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.

Constructor Details

DocumentClientException

public DocumentClientException(int statusCode)

Creates a new instance of the DocumentClientException class.

Parameters:

statusCode - the http status code of the response.

DocumentClientException

public DocumentClientException(int statusCode, Error errorResource, Map responseHeaders)

Creates a new instance of the DocumentClientException class.

Parameters:

statusCode - the http status code of the response.
errorResource - the error resource object.
responseHeaders - the response headers.

DocumentClientException

public DocumentClientException(int statusCode, Exception innerException)

Creates a new instance of the DocumentClientException class.

Parameters:

statusCode - the http status code of the response.
innerException - the original exception.

DocumentClientException

public DocumentClientException(int statusCode, Exception innerException, Map responseHeaders)

Creates a new instance of the DocumentClientException class.

<xreftitle>Deprecated</xreftitle>

<xrefdescription>

  <p>this constructor is deprecated and is used internally only. </p>

</xrefdescription>

Parameters:

statusCode - the http status code of the response.
innerException - the original exception.
responseHeaders - the response headers.

DocumentClientException

public DocumentClientException(int statusCode, String errorMessage)

Creates a new instance of the DocumentClientException class.

Parameters:

statusCode - the http status code of the response.
errorMessage - the error message.

DocumentClientException

public DocumentClientException(String resourceAddress, int statusCode, Error errorResource, Map responseHeaders)

Creates a new instance of the DocumentClientException class.

Parameters:

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.

Method Details

getActivityId

public String getActivityId()

Gets the activity ID associated with the request.

Returns:

the activity ID.

getError

public Error getError()

Gets the error code associated with the exception.

Returns:

the error.

getResponseHeaders

public Map getResponseHeaders()

Gets the response headers as key-value pairs

Returns:

the response headers

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.

getStatusCode

public int getStatusCode()

Gets the http status code.

Returns:

the status code.

getSubStatusCode

public Integer getSubStatusCode()

Gets the sub status code.

Returns:

the status code.

Applies to