Package version:

Interface HealthError

Health Error.

interface HealthError {
    creationTimeUtc?: any;
    customerResolvability?: string;
    entityId?: string;
    errorCategory?: string;
    errorCode?: string;
    errorId?: string;
    errorLevel?: string;
    errorMessage?: string;
    errorSource?: string;
    errorType?: string;
    innerHealthErrors?: InnerHealthError[];
    possibleCauses?: string;
    recommendedAction?: string;
    recoveryProviderErrorMessage?: string;
    summaryMessage?: string;
}

Properties

creationTimeUtc? customerResolvability? entityId? errorCategory? errorCode? errorId? errorLevel? errorMessage? errorSource? errorType? innerHealthErrors? possibleCauses? recommendedAction? recoveryProviderErrorMessage? summaryMessage?

Properties

OptionalcreationTimeUtc

creationTimeUtc?: any

Error creation time (UTC).

OptionalcustomerResolvability

customerResolvability?: string

Value indicating whether the health error is customer resolvable.

OptionalentityId

entityId?: string

ID of the entity.

OptionalerrorCategory

errorCategory?: string

Category of error.

OptionalerrorCode

errorCode?: string

Error code.

OptionalerrorId

errorId?: string

The health error unique id.

OptionalerrorLevel

errorLevel?: string

Level of error.

OptionalerrorMessage

errorMessage?: string

Error message.

OptionalerrorSource

errorSource?: string

Source of error.

OptionalerrorType

errorType?: string

Type of error.

OptionalinnerHealthErrors

innerHealthErrors?: InnerHealthError[]

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.

OptionalpossibleCauses

possibleCauses?: string

Possible causes of error.

OptionalrecommendedAction

recommendedAction?: string

Recommended action to resolve error.

OptionalrecoveryProviderErrorMessage

recoveryProviderErrorMessage?: string

DRA error message.

OptionalsummaryMessage

summaryMessage?: string

Summary message of the entity.

Settings

Member Visibility