Pip-Services-Commons-Dotnet
Properties | List of all members
PipServices3.Commons.Errors.ErrorDescription Class Reference

Serializeable error description. It is use to pass information about errors between microservices implemented in different languages. On the receiving side ErrorDescription is used to recreate exception object close to its original type without missing additional details. More...

Properties

string Type [get, set]
 
string Category [get, set]
 
int Status [get, set]
 
string Code [get, set]
 
string Message [get, set]
 
StringValueMap Details [get, set]
 
string CorrelationId [get, set]
 
string Cause [get, set]
 
string StackTrace [get, set]
 

Detailed Description

Serializeable error description. It is use to pass information about errors between microservices implemented in different languages. On the receiving side ErrorDescription is used to recreate exception object close to its original type without missing additional details.

See ApplicationException, ApplicationExceptionFactory

Property Documentation

◆ Category

string PipServices3.Commons.Errors.ErrorDescription.Category
getset

Standard error category

◆ Cause

string PipServices3.Commons.Errors.ErrorDescription.Cause
getset

Original error wrapped by this exception

◆ Code

string PipServices3.Commons.Errors.ErrorDescription.Code
getset

A unique error code

◆ CorrelationId

string PipServices3.Commons.Errors.ErrorDescription.CorrelationId
getset

A unique transaction id to trace execution throug call chain

◆ Details

StringValueMap PipServices3.Commons.Errors.ErrorDescription.Details
getset

A map with additional details that can be used to restore error description in other languages

◆ Message

string PipServices3.Commons.Errors.ErrorDescription.Message
getset

A human-readable error description (usually written in English)

◆ StackTrace

string PipServices3.Commons.Errors.ErrorDescription.StackTrace
getset

Stack trace of the exception

◆ Status

int PipServices3.Commons.Errors.ErrorDescription.Status
getset

HTTP status code associated with this error type

◆ Type

string PipServices3.Commons.Errors.ErrorDescription.Type
getset

Data type of the original error


The documentation for this class was generated from the following file: