HealthError interface
Health Error.
Properties
creation |
Error creation time (UTC). |
customer |
Value indicating whether the health error is customer resolvable. |
entity |
ID of the entity. |
error |
Category of error. |
error |
Error code. |
error |
The health error unique id. |
error |
Level of error. |
error |
Error message. |
error |
Source of error. |
error |
Type of error. |
inner |
The inner health errors. HealthError having a list of HealthError as child errors is problematic. InnerHealthError is used because this will prevent an infinite loop of structures when Hydra tries to auto-generate the contract. We are exposing the related health errors as inner health errors and all API consumers can utilize this in the same fashion as Exception -> InnerException. |
possible |
Possible causes of error. |
recommended |
Recommended action to resolve error. |
recovery |
DRA error message. |
summary |
Summary message of the entity. |
Property Details
creationTimeUtc
Error creation time (UTC).
creationTimeUtc?: Date
Property Value
Date
customerResolvability
Value indicating whether the health error is customer resolvable.
customerResolvability?: string
Property Value
string
entityId
ID of the entity.
entityId?: string
Property Value
string
errorCategory
Category of error.
errorCategory?: string
Property Value
string
errorCode
Error code.
errorCode?: string
Property Value
string
errorId
The health error unique id.
errorId?: string
Property Value
string
errorLevel
Level of error.
errorLevel?: string
Property Value
string
errorMessage
Error message.
errorMessage?: string
Property Value
string
errorSource
Source of error.
errorSource?: string
Property Value
string
errorType
Type of error.
errorType?: string
Property Value
string
innerHealthErrors
The inner health errors. HealthError having a list of HealthError as child errors is problematic. InnerHealthError is used because this will prevent an infinite loop of structures when Hydra tries to auto-generate the contract. We are exposing the related health errors as inner health errors and all API consumers can utilize this in the same fashion as Exception -> InnerException.
innerHealthErrors?: InnerHealthError[]
Property Value
possibleCauses
Possible causes of error.
possibleCauses?: string
Property Value
string
recommendedAction
Recommended action to resolve error.
recommendedAction?: string
Property Value
string
recoveryProviderErrorMessage
DRA error message.
recoveryProviderErrorMessage?: string
Property Value
string
summaryMessage
Summary message of the entity.
summaryMessage?: string
Property Value
string