HealthErrorResponse

data class HealthErrorResponse(val creationTimeUtc: String? = null, val customerResolvability: String? = null, val entityId: String? = null, val errorCategory: String? = null, val errorCode: String? = null, val errorId: String? = null, val errorLevel: String? = null, val errorMessage: String? = null, val errorSource: String? = null, val errorType: String? = null, val innerHealthErrors: List<InnerHealthErrorResponse>? = null, val possibleCauses: String? = null, val recommendedAction: String? = null, val recoveryProviderErrorMessage: String? = null, val summaryMessage: String? = null)

Health Error.

Constructors

Link copied to clipboard
constructor(creationTimeUtc: String? = null, customerResolvability: String? = null, entityId: String? = null, errorCategory: String? = null, errorCode: String? = null, errorId: String? = null, errorLevel: String? = null, errorMessage: String? = null, errorSource: String? = null, errorType: String? = null, innerHealthErrors: List<InnerHealthErrorResponse>? = null, possibleCauses: String? = null, recommendedAction: String? = null, recoveryProviderErrorMessage: String? = null, summaryMessage: String? = null)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
val creationTimeUtc: String? = null

Error creation time (UTC).

Link copied to clipboard

Value indicating whether the health error is customer resolvable.

Link copied to clipboard
val entityId: String? = null

ID of the entity.

Link copied to clipboard
val errorCategory: String? = null

Category of error.

Link copied to clipboard
val errorCode: String? = null

Error code.

Link copied to clipboard
val errorId: String? = null

The health error unique id.

Link copied to clipboard
val errorLevel: String? = null

Level of error.

Link copied to clipboard
val errorMessage: String? = null

Error message.

Link copied to clipboard
val errorSource: String? = null

Source of error.

Link copied to clipboard
val errorType: String? = null

Type of error.

Link copied to clipboard

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.

Link copied to clipboard
val possibleCauses: String? = null

Possible causes of error.

Link copied to clipboard

Recommended action to resolve error.

Link copied to clipboard

DRA error message.

Link copied to clipboard
val summaryMessage: String? = null

Summary message of the entity.