Notification

@JsonClass(generateAdapter = true)
data class Notification(@Json(name = "associatedRule") val associatedRule: ReportingDescriptorReference? = null, @Json(name = "descriptor") val descriptor: ReportingDescriptorReference? = null, @Json(name = "exception") val exception: Exception? = null, @Json(name = "level") val level: Level? = null, @Json(name = "locations") val locations: List<Location>? = null, @Json(name = "message") val message: Message, @Json(name = "properties") val properties: PropertyBag? = null, @Json(name = "threadId") val threadID: Int? = null, @Json(name = "timeUtc") val timeUTC: String? = null)(source)

Describes a condition relevant to the tool itself, as opposed to being relevant to a target being analyzed by the tool.

Since

0.12.0

Constructors

Link copied to clipboard
constructor(@Json(name = "associatedRule") associatedRule: ReportingDescriptorReference? = null, @Json(name = "descriptor") descriptor: ReportingDescriptorReference? = null, @Json(name = "exception") exception: Exception? = null, @Json(name = "level") level: Level? = null, @Json(name = "locations") locations: List<Location>? = null, @Json(name = "message") message: Message, @Json(name = "properties") properties: PropertyBag? = null, @Json(name = "threadId") threadID: Int? = null, @Json(name = "timeUtc") timeUTC: String? = null)

Properties

Link copied to clipboard

A reference used to locate the rule descriptor associated with this notification.

Link copied to clipboard

A reference used to locate the descriptor relevant to this notification.

Link copied to clipboard
val exception: Exception? = null

The runtime exception, if any, relevant to this notification.

Link copied to clipboard
val level: Level? = null

A value specifying the severity level of the notification.

Link copied to clipboard
val locations: List<Location>? = null

The locations relevant to this notification.

Link copied to clipboard

A message that describes the condition that was encountered.

Link copied to clipboard
val properties: PropertyBag? = null

Key/value pairs that provide additional information about the notification.

Link copied to clipboard
val threadID: Int? = null

The thread identifier of the code that generated the notification.

Link copied to clipboard
val timeUTC: String? = null

The Coordinated Universal Time (UTC) date and time at which the analysis tool generated the notification.