StatusCause

data class StatusCause(val field: String? = null, val message: String? = null, val reason: String? = null)

StatusCause provides more information about an api.Status failure, including cases when multiple errors are encountered.

Constructors

Link copied to clipboard
constructor(field: String? = null, message: String? = null, reason: String? = null)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
val field: String? = null

The field of the resource that has caused this error, as named by its JSON serialization. May include dot and postfix notation for nested attributes. Arrays are zero-indexed. Fields may appear more than once in an array of causes due to fields having multiple errors. Optional. Examples: "name" - the field "name" on the current resource "items0.name" - the field "name" on the first array entry in "items"

Link copied to clipboard
val message: String? = null

A human-readable description of the cause of the error. This field may be presented as-is to a reader.

Link copied to clipboard
val reason: String? = null

A machine-readable description of the cause of the error. If this value is empty there is no information available.