com.azure.data.cosmos

Class CosmosError

java.lang.Object

com.azure.data.cosmos.JsonSerializable

com.azure.data.cosmos.Resource

com.azure.data.cosmos.CosmosError

public class CosmosError
extends Resource

Encapsulates error related details in the Azure Cosmos DB database service.

Constructor Summary

Constructors

Constructor and Description
CosmosError() Initialize a new instance of the Error object.
CosmosError(String errorCode, String message) Initialize a new instance of the Error object.
CosmosError(String errorCode, String message, String additionalErrorInfo) Initialize a new instance of the Error object.

Method Summary

Modifier and Type	Method and Description
String	getCode() Gets the error code.
String	getErrorDetails() Gets the error details.
String	getMessage() Gets the error message.
String	getPartitionedQueryExecutionInfo() Gets the partitioned query execution info.

Methods inherited from class com.azure.data.cosmos.Resource

etag, id, id, resourceId, resourceId, selfLink, timestamp

Methods inherited from class com.azure.data.cosmos.JsonSerializable

get, getBoolean, getCollection, getDouble, getInt, getList, getLogger, getLong, getMap, getObject, getObjectByPath, getString, has, toJson, toJson, toObject, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

CosmosError

public CosmosError()

Initialize a new instance of the Error object.

CosmosError

public CosmosError(String errorCode,
                   String message)

Initialize a new instance of the Error object.

Parameters:

errorCode - the error code.

message - the error message.

CosmosError

public CosmosError(String errorCode,
                   String message,
                   String additionalErrorInfo)

Initialize a new instance of the Error object.

Parameters:

errorCode - the error code.

message - the error message.

additionalErrorInfo - additional error info.

Method Detail

getCode

public String getCode()

Gets the error code.

Returns:

the error code.

getMessage

public String getMessage()

Gets the error message.

Returns:

the error message.

getErrorDetails

public String getErrorDetails()

Gets the error details.

Returns:

the error details.

getPartitionedQueryExecutionInfo

public String getPartitionedQueryExecutionInfo()

Gets the partitioned query execution info.

Returns:

the partitioned query execution info.