UserFacingErrorResponse

data class UserFacingErrorResponse(val code: String? = null, val details: List<UserFacingErrorResponse>? = null, val innerError: InnerErrorResponse? = null, val isRetryable: Boolean? = null, val isUserError: Boolean? = null, val message: String? = null, val properties: Map<String, String>? = null, val recommendedAction: List<String>? = null, val target: String? = null)

Error object used by layers that have access to localized content, and propagate that to user

Constructors

Link copied to clipboard
constructor(code: String? = null, details: List<UserFacingErrorResponse>? = null, innerError: InnerErrorResponse? = null, isRetryable: Boolean? = null, isUserError: Boolean? = null, message: String? = null, properties: Map<String, String>? = null, recommendedAction: List<String>? = null, target: String? = null)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
val code: String? = null

Unique code for this error

Link copied to clipboard

Additional related Errors

Link copied to clipboard

Inner Error

Link copied to clipboard
val isRetryable: Boolean? = null

Whether the operation will be retryable or not

Link copied to clipboard
val isUserError: Boolean? = null

Whether the operation is due to a user error or service error

Link copied to clipboard
val message: String? = null
Link copied to clipboard
val properties: Map<String, String>? = null

Any key value pairs that can be injected inside error object

Link copied to clipboard

RecommendedAction � localized.

Link copied to clipboard
val target: String? = null

Target of the error.